Invoices - Download Documents By Billing Subscription

Referens

Tjänst:: Billing

API-version:: 2024-04-01

Hämtar en URL för att ladda ned flera fakturadokument (pdf-faktura, skattekvitton, kreditfakturor) som en zip-fil. Åtgärden stöds för faktureringskonton med avtalstypen Microsoft-partneravtal eller Microsoft-kundavtal.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/downloadDocuments?api-version=2024-04-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$	Det ID som unikt identifierar en faktureringsprenumeration.
api-version	query	True	string	Den version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2024-04-01.

Begärandetext

Name	Typ	Description
parameters	DocumentDownloadRequest[]	En lista med nedladdningsinformation för enskilda dokument.

Svar

Name

Typ

Description

200 OK

DocumentDownloadResult

En säker URL som kan användas för att ladda ned en entitet tills URL:en upphör att gälla.

202 Accepted

En åtgärd accepterade resultatet som returnerar ett "Plats"-huvud som klienten kan avsöka för att visa resultatet av åtgärden.

Sidhuvuden

Location: string
Retry-After: integer

Other Status Codes

Felsvar som beskriver varför åtgärden misslyckades.

Exempel

InvoicesDownloadDocumentsByBillingSubscription

Exempelbegäran

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/00000000-0000-0000-0000-000000000000/downloadDocuments?api-version=2024-04-01

[
  {
    "documentName": "12345678",
    "invoiceName": "E123456789"
  },
  {
    "documentName": "12345678",
    "invoiceName": "E987654321"
  }
]


import com.azure.resourcemanager.billing.models.DocumentDownloadRequest;
import java.util.Arrays;

/**
 * Samples for Invoices DownloadDocumentsByBillingSubscription.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * invoicesDownloadDocumentsByBillingSubscription.json
     */
    /**
     * Sample code: InvoicesDownloadDocumentsByBillingSubscription.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void
        invoicesDownloadDocumentsByBillingSubscription(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.invoices().downloadDocumentsByBillingSubscription(
            Arrays.asList(new DocumentDownloadRequest().withDocumentName("12345678").withInvoiceName("E123456789"),
                new DocumentDownloadRequest().withDocumentName("12345678").withInvoiceName("E987654321")),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python invoices_download_documents_by_billing_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.invoices.begin_download_documents_by_billing_subscription(
        parameters=[
            {"documentName": "12345678", "invoiceName": "E123456789"},
            {"documentName": "12345678", "invoiceName": "E987654321"},
        ],
    ).result()
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingSubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armbilling_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c08ac9813477921ad8295b98ced8f82d11b8f913/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingSubscription.json
func ExampleInvoicesClient_BeginDownloadDocumentsByBillingSubscription() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewInvoicesClient().BeginDownloadDocumentsByBillingSubscription(ctx, []*armbilling.DocumentDownloadRequest{
		{
			DocumentName: to.Ptr("12345678"),
			InvoiceName:  to.Ptr("E123456789"),
		},
		{
			DocumentName: to.Ptr("12345678"),
			InvoiceName:  to.Ptr("E987654321"),
		}}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DocumentDownloadResult = armbilling.DocumentDownloadResult{
	// 	ExpiryTime: to.Ptr("2023-02-16T17:32:28Z"),
	// 	URL: to.Ptr("https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
 *
 * @summary Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingSubscription.json
 */
async function invoicesDownloadDocumentsByBillingSubscription() {
  const subscriptionId =
    process.env["BILLING_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const parameters = [
    { documentName: "12345678", invoiceName: "E123456789" },
    { documentName: "12345678", invoiceName: "E987654321" },
  ];
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result =
    await client.invoices.beginDownloadDocumentsByBillingSubscriptionAndWait(parameters);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Billing.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingSubscription.json
// this example is just showing the usage of "Invoices_DownloadDocumentsByBillingSubscription" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

TenantResource tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// invoke the operation
string subscriptionId = "00000000-0000-0000-0000-000000000000";
IEnumerable<BillingDocumentDownloadRequestContent> arrayOfDocumentDownloadRequest = new BillingDocumentDownloadRequestContent[]
{
new BillingDocumentDownloadRequestContent
{
DocumentName = "12345678",
InvoiceName = "E123456789",
},
new BillingDocumentDownloadRequestContent
{
DocumentName = "12345678",
InvoiceName = "E987654321",
}
};
ArmOperation<BillingDocumentDownloadResult> lro = await tenantResource.DownloadDocumentsByBillingSubscriptionInvoiceAsync(WaitUntil.Completed, subscriptionId, arrayOfDocumentDownloadRequest);
BillingDocumentDownloadResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exempelsvar

Statuskod:: 200

{
  "expiryTime": "2023-02-16T17:32:28Z",
  "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r"
}

Statuskod:: 202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/00000000-0000-0000-0000-000000000000/operationResults/invoiceDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01
Retry-After: 10

Definitioner

Name	Description
DocumentDownloadRequest	En lista med nedladdningsinformation för enskilda dokument.
DocumentDownloadResult	En säker URL som kan användas för att ladda ned en entitet tills URL:en upphör att gälla.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar

DocumentDownloadRequest

Objekt

En lista med nedladdningsinformation för enskilda dokument.

Name	Typ	Description
documentName	string	Det ID som unikt identifierar ett fakturadokument. Det här ID:t kan vara en identifierare för en PDF-faktura, en kreditfaktura eller ett skattekvitto. Om den utelämnas returneras den senaste PDF-fakturan för fakturan.
invoiceName	string	Det ID som unikt identifierar en faktura.

DocumentDownloadResult

Objekt

En säker URL som kan användas för att ladda ned en entitet tills URL:en upphör att gälla.

Name	Typ	Description
expiryTime	string	Tiden i UTC när nedladdnings-URL:en upphör att gälla.
url	string	URL:en till PDF- eller .zip-filen.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.