Obtenir les détails de la facture #
Obtenez une ventilation détaillée de tous les articles facturés pour une facture spécifique. Un fichier ZIP est renvoyé à partir de cette requête qui contient un JSON et un CSV lime. Chaque fichier contient un enregistrement de chaque transaction dans la facture.
GET /v1.0/billingdata/{INVOICE_ID}/detail
Exemple #
Cette demande récupérera une répartition des éléments pour un identifiant de facture spécifique.
Demander #
GET /api/v1.0/billingdata/{INVOICE_ID}/detail HTTP/1.1
Autorisation : Porteur {TOKEN}Réponse #
HTTP/1.1 200 OK
Type de contenu : application/flux d'octets ; jeu de caractères=utf-8
Contenu-Longueur : xx
{
« status » : « succès »,
« timestamp » : « 2019-01-01T10:00:00.2890319Z »
}Exemple JSON Données #
{
« tenantId » : « 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 »,
« invoiceValue » : 17,50,
« invoiceItems » : \[
{
« id » : « 000000000000000000000001 »,
« quantité » : 1,0,
« valeur » : 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 » : « client.utilisateur.pbx »
},
{
« name » : « ResellerCode »,
« value » : « 00000000-0000-0000-0000-00000000222 »
},
{
« name » : « ResellerCodeExt »,
« value » : « revendeur ref 1 »
},
{
« name » : « ResellerName »,
« value » : « Revendeur ABC »
},
{
« name » : « TenantCode »,
« value » : « 00000000-0000-0000-0000-0000000111 »
},
{
« name » : « TenantCodeExt »,
« value » : « Réf personnalisée 1 »
},
{
« name » : « TenantName »,
« value » : « Exemple de client 1 »
},
{
« name » : « UserId »,
« value » : « 00000000-0000-0000-0000-00000-0000000001 »
},
{
« 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 »,
« quantité » : 1,0,
« valeur » : 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 » : « client.utilisateur.supervisorl2 »
},
{
« name » : « ResellerCode »,
« value » : « 00000000-0000-0000-0000-00000000222 »
},
{
« name » : « ResellerCodeExt »,
« value » : « revendeur ref 1 »
},
{
« name » : « ResellerName »,
« value » : « Revendeur ABC »
},
{
« name » : « TenantCode »,
« value » : « 00000000-0000-0000-0000-0000000111 »
},
{
« name » : « TenantCodeExt »,
« value » : « Réf personnalisée 1 »
},
{
« name » : « TenantName »,
« value » : « Exemple de client 1 »
},
{
« name » : « UserId »,
« value » : « 00000000-0000-0000-0000-00000-0000000001 »
},
{
« 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 »,
« quantité » : 3.0,
« valeur » : 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 » : [« Résumé », « Total », « GL », « GL_Entry :0000 ; crédit ;"][ "Summary", "Total", "GL", "GL_Entry:0000;credit;" ],
« stringValues » : [][ ]
},
{
« id » : « 000000000000000000000005 »,
« quantité » : 3.0,
« valeur » : 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 », « Summary », « GL_Balance », « GL_Entry :2222 ; débit; Débiteurs"][ "TotalInclVAT", "Summary", "GL_Balance", "GL_Entry:2222;debit;Debtors" ],
« stringValues » : [][ ]
},
{
« id » : « 000000000000000000000006 »,
« quantité » : 345.0,
« valeur » : 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 », « Summary », « GL_VAT », « VAT :S », « GL_Entry :1111 ; crédit; TVA"][ "TotalVAT", "Summary", "GL_VAT", "VAT:S", "GL_Entry:1111;credit;VAT" ],
« stringValues » : [][ ]
}
],
« invoiceType » : 0
}Exemple CSV Données #
id,quantité,valeur,dudate,àdate,nom du produit,numéro de pièce,code locataire,code locataireext,nom locataire,identifiant utilisateur,nom d'utilisateur,code revendeur,code revendeurext,nom revendeur
00000000000000000000001,1,1.25,2020-04-01T00:00:00.000+00:00,2020-04-30T23:59:59.000+00:00,Utilisateur essentiel,#XDM00001,00000000-0000-0000-0000-0000-000000111,réf personnalisée 1,Exemple de client 1,00000000-0000-00000-000000000-0000000001,[[email protected]](mailto:[email protected]),00000000-0000-0000-00000-00000000222,revendeur ref 1,ABC Revendeur
000000000000000000000003,1,15,2020-04-01T00:00:00.000+00:00,2020-04-30T23:59:59.000+00:00,Superviseur en temps réel,#XDM00010,00000000-0000-0000-0000-00000-000000111,Réf personnalisée 1,Exemple de client 1,00000000-0000-0000-00000000-00000000001,[[email protected]](mailto:[email protected]),00000000-0000-0000-00000-00000000222,revendeur ref 1,ABC RevendeurErreurs #
Non autorisée #
Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré
HTTP/1.1 401 Non autoriséIntrouvable #
Lorsqu'il n'y a pas de factures avec un numéro de facture correspondant
HTTP/1.1 404 Introuvable
Date : Thu, 06 Feb 2020 12:46:58 GMT
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : 95
{
« error » : 404,
« message » : « Introuvable »,
« status » : « erreur »,
« timestamp » : « 2020-02-06T12:46:58.7669535Z »
}