API de rapprochement de facture facturée v2 (GA)

S’applique à : Espace partenaires (indisponible dans le cloud souverain)

Notre nouvelle API asynchrone offre un moyen plus rapide et plus efficace d’accéder à vos données de facturation et de rapprochement via des objets blob Azure. Au lieu de conserver une connexion ouverte pendant des heures ou de traiter des lots de 2 000 éléments de ligne, vous pouvez maintenant simplifier votre flux de travail.

La nouvelle API de rapprochement des factures facturées au commerce utilise des techniques avancées telles que la clé de valet et les modèles de demande-réponse asynchrones. Cette API vous fournit un jeton de signature d’accès partagé (SAP) que vous pouvez utiliser pour accéder à tous les attributs ou à un sous-ensemble des données de rapprochement de facture facturées.

Notre API utilise des techniques optimisées pour améliorer votre efficacité, ce qui vous permet d’obtenir des résultats plus rapides avec moins d’efforts. Adoptez cette API pour simplifier l’accès aux données et améliorer votre efficacité globale.

Présentation de l’API

Pour vous aider à récupérer les nouveaux éléments de ligne de rapprochement de facture commerciale facturés de façon asynchrone, nous proposons deux points de terminaison d’API clés. Voici un guide simplifié pour vous aider à démarrer :

Point de terminaison de rapprochement de facture facturé

Tout d’abord, utilisez cette API pour récupérer les nouveaux éléments de ligne de rapprochement de facture facturés au commerce . Lorsque vous effectuez une requête, vous recevez un état HTTP 202 et un en-tête d’emplacement avec une URL. Interrogez régulièrement cette URL jusqu’à ce que vous obteniez un état de réussite et une URL de manifeste.

Point de terminaison d’état de l’opération

Ensuite, continuez à vérifier l’état de l’opération en appelant cette API à intervalles réguliers. Si les données ne sont pas prêtes, la réponse inclut un en-tête Retry-After indiquant la durée d’attente avant de réessayer. Une fois l’opération terminée, vous recevez une ressource de manifeste avec un lien de dossier de stockage pour télécharger les données d’utilisation. La réponse segmente les fichiers pour améliorer le débit et permettre un parallélisme d’E/S.

En suivant ces étapes, vous pouvez gérer efficacement votre processus de rapprochement de facture.

Diagramme de séquence

Voici un diagramme de séquence qui montre les étapes de téléchargement des nouvelles données de rapprochement des factures commerciales.

Séquence d’actions utilisateur

Pour récupérer les données de rapprochement des factures facturées, procédez comme suit :

Étape 1 : Envoyer une demande

Envoyez une requête POST au point de terminaison de l’API.

Obtenir les éléments de ligne de rapprochement de facture facturés

Requête d’API

POST https://graph.microsoft.com/v1.0/reports/partners/billing/reconciliation/billed/export

Accept: application/json

Content-Type: application/json

{

"invoiceId": "G016907411",

"attributeSet": "basic"

}

Paramètres de requête

S/O

Corps de la demande

En-têtes de requête

En-têtes de demande pour l’API à l’aide des étapes répertoriées dans les meilleures pratiques pour l’utilisation de Microsoft Graph. En suivant ces instructions, vous garantissez la fiabilité et la prise en charge de votre application. Votre attention aux détails de cette étape est essentielle à l’intégration transparente et aux performances optimales.

Réponse de l’API

HTTP/1.1 202 Accepted  
Location: <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>

L’API répond généralement avec un état HTTP 202. Vous pouvez également rencontrer d’autres états en fonction de vos demandes. Ces états sont répertoriés dans la section États de réponse de l’API Standard.

Étape 2 : Vérifier l’état de la demande

Pour suivre l’état d’une demande, veillez à recevoir une réponse HTTP 200 indiquant « réussi » ou « échoué ». Si elle réussit, vous trouvez l’URL du manifeste dans l’attribut « resourceLocation ». Cet attribut fournit un point de terminaison pour accéder aux informations requises.

Obtenir l’état de l’opération

Récupère l’état d’une demande.

Requête d’API

GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>

Paramètres de la demande

En-tête de requête

En-têtes de demande pour l’API à l’aide des étapes répertoriées dans les meilleures pratiques pour l’utilisation de Microsoft Graph. En suivant ces instructions, vous garantissez la fiabilité et la prise en charge de votre application. Votre attention aux détails de cette étape est essentielle à l’intégration transparente et aux performances optimales.

Corps de la demande

N/A.

État de la réponse

Outre les états HTTP standard répertoriés dans les états de réponse de l’API Standard, l’API peut également retourner l’état HTTP suivant :

Charge utile de réponse

La charge utile de réponse de l’API inclut les attributs suivants :

Objet Resource Location

Requête d’API

GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>

Réponse de l’API

La réponse recommande d’attendre 10 secondes avant de réessayer lorsque vos données sont toujours traitées.

HTTP/1.1 200 OK  
Retry-After: 10  
{  
"id": "9ab9cb54-d07f-4f52-9ea6-a09d7de52c14",  
"createdDateTime": "2022-06-1T10-01-03.4Z",  
"lastActionDateTime": "2022-06-1T10-01-05Z",  
"status": "running"  
}

Requête d’API

(10 secondes après la demande précédente...)

GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>

Réponse de l’API

L’API retourne l’état « réussi » et l’URI de « resourceLocation ».

HTTP/1.1 200 OK  
Content-Type: application/json  
{

    "@odata.context": "https://graph.microsoft.com/v1.0/\$metadata#reports/partners/billing/operations/\$entity",

    "@odata.type": "#microsoft.graph.partners.billing.exportSuccessOperation",

    "id": "f2170b13-6a8e-47d6-b481-6988490dc0cb",

    "createdDateTime": "2023-12-05T21:17:29Z",

    "lastActionDateTime": "2023-12-05T21:18:00.8897902Z",

    "status": "succeeded",

    "resourceLocation": {

        "id": "44e8500b-ab92-490e-8ac3-90500a1d3427",

        "createdDateTime": "2023-11-06T19:58:47.513Z",

        "schemaVersion": "2",

        "dataFormat": "compressedJSON",

        "partitionType": "default",

        "eTag": "RwDrn7fbiTXy6UULE",

        "partnerTenantId": "0e195b37-4574-4539-bc42-0e539b9684c0",

        "rootDirectory": "https://adlsreconbuprodeastus201.blob.core.windows.net/path_id",

        "sasToken": "{token}",

        "blobCount": 1,

        "blobs": \[

            {

                "name": "part-00123-5a93fa5d-749f-48bc-a372-9b021d93c3fa.c000.json.gz",

                "partitionValue": "default"

            }

        \]

    }

}

Étape 3 : Télécharger les éléments de ligne de rapprochement de facture facturés à partir du stockage Blob Azure

Tout d’abord, vous devez obtenir le jeton de signature d’accès partagé (SAP) et l’emplacement de stockage d’objets blob. Vous trouverez ces détails dans les propriétés « sasToken » et « rootDirectory » de la réponse de l’API de charge utile du manifeste. Ensuite, pour télécharger et décompresser le fichier blob, utilisez le kit sdk/outil Stockage Azure. Il est au format JSONLines .

États de réponse de l’API standard

Vous pouvez obtenir ces états HTTP à partir de la réponse de l’API :

Attributs d’élément de ligne de rapprochement de facture facturés

Pour comparer les attributs retournés par l’API de rapprochement de facture facturée pour les ensembles d’attributs « full » ou « basic », reportez-vous au tableau suivant. Pour en savoir plus sur ces attributs, consultez Utilisation du fichier de reconquête.

Exemple de code

Pour utiliser cette API, consultez le lien suivant, qui inclut l’exemple de code C#.

Exemples partner-Center-Billing-Recon-Samples : exemples d’API pour obtenir des données de reconquête de facturation à partir de l’Espace partenaires (github.com).