Données de facturation JSON #
Les renseignements ci-dessous fournissent des détails sur le JSON données fournies lors du téléchargement des données d'une facture spécifique. Le JSON Les données fournissent le niveau d'information le plus granulaire, y compris les entrées pour chaque licence d'utilisation utilisée et les entrées sommaires fournissant des renseignements sur les totaux des factures et les taxes applicables.
Schéma des détails de la facture #
Le principal JSON fournit des détails sur le numéro de facture, la période et la date. Il contient également un éventail d'éléments de facture individuels qui se rapportent à chaque licence facturée.
| Clé | Descriptif | Type |
|---|---|---|
| LocataireID | L'identifiant du compte de revendeur parent | Chaîne |
| Numéro de facture | Un numéro unique pour identifier une facture particulière | Chaîne |
| numéro de facture | Le numéro de facture affiché sur le bouton PDF facture | Chaîne |
| nom du compte | Le nom de l'entreprise pour le compte de revendeur parent | Chaîne |
| Période de facturationDébut | La date de début de la période de facturation | Chaîne |
| facturationpériodefin | La date à laquelle la période de facturation se termine | Chaîne |
| valeur de la facture | La valeur totale de la facture | double |
| Éléments de facture | Une collection d'articles de facture | tableau(Élément de facture) |
JSON Schéma de l'article de facture #
Chaque entrée d'article de facture dans le JSON Les données de facturation fournissent les paramètres énumérés ci-dessous. Ils font référence à une utilisation individuelle par un utilisateur avec les plages de dates applicables.
| Clé | Descriptif | Type |
|---|---|---|
| Identifiant | Un identifiant unique pour l'achat individuel | Chaîne |
| quantité1 | La quantité utilisée | double |
| Valeur | Le coût de l'article | double |
| à partir de la date | La date à partir de laquelle l'article est facturé | Chaîne |
| à ce jour | La date à partir de laquelle l'article est facturé | Chaîne |
| Ordre de calcul | Numéro séquentiel indiquant l'ordre dans lequel les articles de facture doivent être traités | int |
| Utilisé par l'utilisateur | Indique comment la valeur de l'élément de facture est appliquée à la facture | Opérateur d'article de facture |
| operatorvalueused | Indique la valeur de l'opérateur ADJUSTPERCENTAGE | double |
| producttagname | Le nom de la fonctionnalité ou du produit pour lequel l'article de facture est destiné. Ce sera dans le format '{PRODUCT_NAME} #{PART_NUMBER}' | Chaîne |
| billingoutputtags | Indiquer si l'article de la facture est destiné à un achat ou s'il s'agit d'un champ sommaire | tableau(chaîne) |
| stringValeurs | Fournit des renseignements sur le client et l'utilisateur final auquel l'achat est destiné | Paire clés-valeurs< chaîne,chaîne> |
| valeurs numériques | Fournit des renseignements sur le client et l'utilisateur final auquel l'achat est destiné | Paire clés-valeurs< corde,double> |
Opérateurs d'articles de facture #
L'opérateur de chaque article indique comment l'article est appliqué à la facture. PurchaseResult aura un PRIX pour déterminer le coût de l'article. Les articles avec d'autres étiquettes de sortie indiqueront s'ils additionnent la valeur de la facture ou s'ils appliquent une valeur en pourcentage à des articles précédents, comme la taxe de vente.
| Objets | Descriptif |
|---|---|
| PRIX | Indique que l'article de la facture indique le prix unitaire d'un article |
| SOMME | Indique que l'article de la facture affiche un total de plusieurs articles |
| AJUSTEMENTPOURCENTAGE | Indique que l'article de la facture affiche un ajustement en pourcentage de la SOMME, ce qui indique généralement que la TVA est appliquée |
Éléments de la balise de sortie de facturation #
Les étiquettes 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 sommaire fournissant des renseignements sur l'ensemble de la facture.
| Objets | Descriptif |
|---|---|
| Résultat de l'achat | Indique que l'article de la facture est un achat facturable |
| Résumé | Indique que l'article de la facture est un résumé des achats, fournissant des informations sur le total de la facture. Lorsqu'il est seul sans les balises « TotalVATA » ou « TotalInclVAT, il indique le total de la facture avant l'ajout de la TVA. |
| TotalInclVAT | Indique que l'article de la facture affiche le total de la facture, y compris la TVA applicable. |
| TVA totale | Indique que l'article de la facture affiche la TVA totale applicable à la facture |
Éléments de valeur de chaîne #
Les éléments de valeur de chaîne fournissent des informations spécifiques au client et à l'utilisateur final de l'article acheté.
| Clé | Descriptif | |
|---|---|---|
| CodeLocataire2 | L'identifiant du locataire revendeur | |
| TenantCodeext2 | La référence du revendeur pour le revendeur | |
| NomLocataire2 | Le nom du revendeur | Chaîne |
| Code revendeur | L'identifiant du locataire du revendeur | |
| RevendCodeExt | La référence étendue pour le revendeur | |
| Nom du revendeur | Le nom du revendeur | |
| Identifiant de l'utilisateur | L'identifiant de l'utilisateur | |
| Nom d'utilisateur | Le nom d'utilisateur de l'utilisateur | |
| rôle | La clé de rôle pour l'article facturé |
Éléments à valeur numérique #
Les éléments à valeur numérique fournissent des renseignements spécifiques au client et à l'utilisateur final de l'article acheté.
| Clé | Descriptif |
|---|---|
| customer_licence_count | Le nombre total de ces licences que le client détient |
Exemple JSON Sortie #
{
« locataireId » : « 00000000-0000-0000-0000-123456789123 »,
« invoiceId » : « 00000000000000000000000a »,
« invoiceNumber » : « 9000004 »,
« accountName » : « Exemple de locataire 1 »,
« billingPeriodStart » : « 2020-04-01T00:00:00.0000000 »,
« billingPeriodEnd » : « 2020-04-30T23:59:59.0000000 »,
« invoiceDate » : « 2020-04-09T00:00:00.0000000 »,
« ValeurFacture » : 17,50,
« invoiceItems » : \[
{
« id » : « 000000000000000000000001 »,
« quantity » : 1,0,
« value » : 1,25,
« fromDate » : « 2020-04-01T00:00:00.000+00:00 »,
« toDate » : « 2020-04-30T23:59:59.000+00:00 »,
« calculationOrder » : 1,
« operatorUsed » : « PRIX »,
« operatorValueUsed » : 1,25,
« productTagName » : « Utilisateur essentiel #XDM00001 »,
« billingOutputTags » : [« PurchaseResult »][ "PurchaseResult" ],
« stringValues » : [
{
« name » : « Rôle »,
« value » : « customer.user.pbx »
},
{
« name » : « ResellerCode »,
« value » : « 00000000-00000-0000-00000-0000000000222 »
},
{
« name » : « ResellerCodeExt »,
« value » : « reseller ref 1 »
},
{
« name » : « ResellerName »,
« value » : « ABC Reseller »
},
{
« name » : « Code locataire »,
« value » : « 00000000-00000-00000-0000000000000111 »
},
{
« name » : « TenantCodeExt »,
« value » : « Custom Ref 1 »
},
{
« name » : « LocataireName »,
« value » : « Exemple de client 1 »
},
{
« name » : « UserId »,
« value » : « 00000000-0000-0000-0000-0000000000000001 »
},
{
« name » : « Nom d'utilisateur »,
« value » : « [email protected] »
}
][
{
"name": "Role",
"value": "customer.user.pbx"
},
{
"name": "ResellerCode",
"value": "00000000-0000-0000-0000-000000000222"
},
{
"name": "ResellerCodeExt",
"value": "reseller ref 1"
},
{
"name": "ResellerName",
"value": "ABC Reseller"
},
{
"name": "TenantCode",
"value": "00000000-0000-0000-0000-000000000111"
},
{
"name": "TenantCodeExt",
"value": "custom ref 1"
},
{
"name": "TenantName",
"value": "Example Customer 1"
},
{
"name": "UserId",
"value": "00000000-0000-0000-0000-000000000001"
},
{
"name": "UserName",
"value": "[email protected]"
}
],
« numericValues » : [
{
« name » : « customer_licence_count »,
« valeur » : 1
}
][
{
"name": "customer_licence_count",
"value": 1
}
]
},
{
« id » : « 000000000000000000000003 »,
« quantity » : 1,0,
« value » : 15,0,
« fromDate » : « 2020-04-01T00:00:00.000+00:00 »,
« toDate » : « 2020-04-30T23:59:59.000+00:00 »,
« calculationOrder » : 3,
« operatorUsed » : « PRIX »,
« operatorValueUsed » : 15,00,
« productTagName » : « Superviseur en temps réel #XDM00010 »,
« billingOutputTags » : [« PurchaseResult »][ "PurchaseResult" ],
« stringValues » : [
{
« name » : « Rôle »,
« value » : « customer.user.supervisorl2 »
},
{
« name » : « ResellerCode »,
« value » : « 00000000-00000-0000-00000-0000000000222 »
},
{
« name » : « ResellerCodeExt »,
« value » : « reseller ref 1 »
},
{
« name » : « ResellerName »,
« value » : « ABC Reseller »
},
{
« name » : « Code locataire »,
« value » : « 00000000-00000-00000-0000000000000111 »
},
{
« name » : « TenantCodeExt »,
« value » : « Custom Ref 1 »
},
{
« name » : « LocataireName »,
« value » : « Exemple de client 1 »
},
{
« name » : « UserId »,
« value » : « 00000000-0000-0000-0000-0000000000000001 »
},
{
« name » : « Nom d'utilisateur »,
« value » : « [email protected] »
}
][
{
"name": "Role",
"value": "customer.user.supervisorl2"
},
{
"name": "ResellerCode",
"value": "00000000-0000-0000-0000-000000000222"
},
{
"name": "ResellerCodeExt",
"value": "reseller ref 1"
},
{
"name": "ResellerName",
"value": "ABC Reseller"
},
{
"name": "TenantCode",
"value": "00000000-0000-0000-0000-000000000111"
},
{
"name": "TenantCodeExt",
"value": "custom ref 1"
},
{
"name": "TenantName",
"value": "Example Customer 1"
},
{
"name": "UserId",
"value": "00000000-0000-0000-0000-000000000001"
},
{
"name": "UserName",
"value": "[email protected]"
}
],
« numericValues » : [
{
« name » : « customer_licence_count »,
« valeur » : 1
}
][
{
"name": "customer_licence_count",
"value": 1
}
]
},
{
« id » : « 000000000000000000000004 »,
« quantity » : 3,0,
« value » : 17,50,
« fromDate » : « 2020-04-01T00:00:00.000+00:00 »,
« toDate » : « 2020-04-30T23:59:59.000+00:00 »,
« calculationOrder » : 4,
« operatorUsed » : « SOMME »,
« operatorValueUsed » : 0,0,
« productTagName » : « Tous les produits »,
« billingOutputTags » : [« Sommaire », « Total », « GL », « GL_Entry :0000; crédit;"][ "Summary", "Total", "GL", "GL_Entry:0000;credit;" ],
« stringValues » : [][ ]
},
{
« id » : « 000000000000000000000005 »,
« quantity » : 3,0,
« value » : 17,50,
« fromDate » : « 2020-04-01T00:00:00.000+00:00 »,
« toDate » : « 2020-04-30T23:59:59.000+00:00 »,
« calculationOrder » : 5,
« operatorUsed » : « ADJUSTPERCENTAGE »,
« operatorValueUsed » : 0,0,
« productTagName » : « Tous les produits »,
« billingOutputTags » : [« TotalInclVAT », « Sommaire », « GL_Balance », « GL_Entry :2222; débit; Débiteurs »][ "TotalInclVAT", "Summary", "GL_Balance", "GL_Entry:2222;debit;Debtors" ],
« stringValues » : [][ ]
},
{
« id » : « 000000000000000000000006 »,
« quantité » : 345,0,
« value » : 0,0,
« fromDate » : « 2020-04-01T00:00:00.000+00:00 »,
« toDate » : « 2020-04-30T23:59:59.000+00:00 »,
« calculationOrder » : 6,
« operatorUsed » : « ADJUSTPERCENTAGE »,
« operatorValueUsed » : 0,0,
« productTagName » : « Tous les produits »,
« billingOutputTags » : [« TotalVAT, « Sommaire », « GL_VAT », « TVA :S », « GL_Entry :1111; crédit; TVA"][ "TotalVAT", "Summary", "GL_VAT", "VAT:S", "GL_Entry:1111;credit;VAT" ],
« stringValues » : [][ ]
}
],
« TypeFacture » : 0
}