API för fakturerad fakturaavstämning v2 (GA)

Gäller för: Partnercenter (ej tillgängligt i nationellt moln)

Vårt nya asynkrona API erbjuder ett snabbare och effektivare sätt att komma åt dina fakturerings- och avstämningsdata via Azure-blobar. I stället för att hålla en anslutning öppen i timmar eller bearbeta batchar med 2 000 radobjekt kan du nu effektivisera arbetsflödet.

Det nya API:et för fakturaavstämning som faktureras för handel använder avancerade tekniker som valet-nyckel och asynkrona mönster för begärandesvar . Det här API:et ger dig en SAS-token (signatur för delad åtkomst) som du kan använda för att komma åt antingen alla attribut eller en delmängd av fakturaavstämningsdata.

Vårt API använder optimerade tekniker för att öka din effektivitet, så att du kan uppnå snabbare resultat med mindre ansträngning. Använd det här API:et för att förenkla din dataåtkomst och förbättra din övergripande effektivitet.

API-översikt

För att hjälpa dig att hämta fakturerade nya handelsfakturaavstämningsradobjekt asynkront erbjuder vi två viktiga API-slutpunkter. Här är en smidig guide för att komma igång:

Slutpunkt för fakturerad fakturaavstämning

Använd först det här API:et för att hämta nya fakturerade fakturaavstämningsradobjekt för handel . När du gör en begäran får du HTTP-status 202 och en platsrubrik med en URL. Avsök den här URL:en regelbundet tills du får en lyckad status och en manifest-URL.

Slutpunkt för åtgärdsstatus

Fortsätt sedan att kontrollera åtgärdsstatusen genom att anropa det här API:et med jämna mellanrum. Om data inte är klara innehåller svaret ett återförsökshuvud som anger hur lång tid det tar att vänta innan du försöker igen. När åtgärden är klar får du en manifestresurs med en länk till lagringsmappen för att ladda ned användningsdata. Svaret segmentar filerna för att förbättra dataflödet och möjliggöra I/O-parallellitet.

Genom att följa dessa steg kan du effektivt hantera fakturaavstämningsprocessen.

Sekvensdiagram

Här är ett sekvensdiagram som visar stegen för att ladda ned nya handelsfakturaavstämningsdata.

Åtgärdssekvens för användare

Följ dessa steg för att hämta fakturerade fakturaavstämningsdata:

Steg 1: Skicka begäran

Skicka en POST-begäran till API-slutpunkten.

Hämta fakturerade fakturaavstämningsradobjekt

API-begäran

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

Accept: application/json

Content-Type: application/json

{

"invoiceId": "G016907411",

"attributeSet": "basic"

}

Frågeparametrar

Ej tillämpligt

Begärandetext

Begärandehuvuden

Begär rubriker för API:et med hjälp av de steg som anges i Metodtips för att använda Microsoft Graph. Genom att följa dessa riktlinjer säkerställer du tillförlitlighet och support för ditt program. Din uppmärksamhet på detaljer i det här steget är avgörande för sömlös integrering och optimala prestanda.

API-svar

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

API:et svarar vanligtvis med http 202-status. Du kan också stöta på andra statusar beroende på dina begäranden. Dessa statusar visas i avsnittet Standard-API-svarsstatusar .

Steg 2: Kontrollera status för begäran

Om du vill hålla reda på status för en begäran kontrollerar du att du får ett HTTP 200-svar som anger "lyckades" eller "misslyckades". Om det lyckas hittar du manifest-URL:en i attributet "resourceLocation". Det här attributet ger en slutpunkt för åtkomst till nödvändig information.

Hämta åtgärdsstatus

Hämtar status för en begäran.

API-begäran

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

Parametrar för begäran

Begärandehuvud

Begär rubriker för API:et med hjälp av de steg som anges i Metodtips för att använda Microsoft Graph. Genom att följa dessa riktlinjer säkerställer du tillförlitlighet och support för ditt program. Din uppmärksamhet på detaljer i det här steget är avgörande för sömlös integrering och optimala prestanda.

Begärandetext

Saknas.

Svarsstatus

Förutom de standard-HTTP-statusar som anges i Standard API-svarsstatusar kan API:et också returnera följande HTTP-status:

Svarsnyttolast

API-svarsnyttolasten innehåller följande attribut:

Resursplatsobjekt

API-begäran

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

API-svar

Svaret rekommenderar att du väntar i 10 sekunder innan du försöker igen när dina data fortfarande bearbetas.

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"  
}

API-begäran

(10 sekunder efter föregående begäran...)

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

API-svar

API:et returnerar statusen "lyckades" och URI:n för "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"

            }

        \]

    }

}

Steg 3: Ladda ned fakturerade fakturaavstämningsradobjekt från Azure Blob Storage

Först måste du hämta sas-token (signatur för delad åtkomst) och bloblagringsplatsen. Du hittar den här informationen i egenskaperna "sasToken" och "rootDirectory" för api-svaret för manifestnyttolasten. Om du sedan vill ladda ned och packa upp blobfilen använder du Azure Storage SDK/-verktyget. Den är i JSONLines-format .

Standard-API-svarsstatusar

Du kan få dessa HTTP-statusar från API-svaret:

Attribut för fakturerade fakturaavstämningsobjekt

Om du vill jämföra attributen som returneras av API:et för fakturerad fakturaavstämning för attributuppsättningarna "full" eller "basic" läser du följande tabell. Mer information om dessa attribut finns i Använda rekognoseringsfilen.

Exempelkod

Om du vill använda det här API:et läser du följande länk, som innehåller C#-exempelkod.

Partner-Center-Billing-Recon-Samples: Exempel för API för att hämta faktureringsrekonfigureringsdata från Partnercenter (github.com).