Invoices - Download Documents By Billing Account

Odwołanie

Usługa:: Billing

Wersja interfejsu API:: 2024-04-01

Pobiera adres URL umożliwiający pobranie wielu dokumentów faktur (pdf faktury, paragonów podatkowych, notatek kredytowych) jako pliku zip. Ta operacja jest obsługiwana w przypadku kont rozliczeniowych z typem umowy Microsoft Partner Agreement lub Umową z Klientem Microsoft.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
billingAccountName	path	True	string pattern: ^([0-9]+\|([Pp][Cc][Nn]\.[A-Za-z0-9]+)\|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$	Identyfikator, który jednoznacznie identyfikuje konto rozliczeniowe.
api-version	query	True	string	Wersja interfejsu API, która ma być używana z żądaniem klienta. Bieżąca wersja to 2024-04-01.

Treść żądania

Nazwa	Typ	Opis
parameters	DocumentDownloadRequest[]	Lista szczegółów pobierania poszczególnych dokumentów.

Odpowiedzi

Nazwa

Typ

Opis

200 OK

DocumentDownloadResult

Bezpieczny adres URL, który może służyć do pobierania jednostki do momentu wygaśnięcia adresu URL.

202 Accepted

Operacja zaakceptowała wynik, który zwraca nagłówek "Lokalizacja", który klient może sondować, aby wyświetlić wynik operacji.

Nagłówki

Location: string
Retry-After: integer

Other Status Codes

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

InvoicesDownloadDocumentsByBillingAccount

Przykładowe żądanie

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

[
  {
    "documentName": "12345678",
    "invoiceName": "G123456789"
  },
  {
    "documentName": "12345678",
    "invoiceName": "G987654321"
  }
]


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

/**
 * Samples for Invoices DownloadDocumentsByBillingAccount.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * invoicesDownloadDocumentsByBillingAccount.json
     */
    /**
     * Sample code: InvoicesDownloadDocumentsByBillingAccount.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void
        invoicesDownloadDocumentsByBillingAccount(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.invoices().downloadDocumentsByBillingAccount(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
            Arrays.asList(new DocumentDownloadRequest().withDocumentName("12345678").withInvoiceName("G123456789"),
                new DocumentDownloadRequest().withDocumentName("12345678").withInvoiceName("G987654321")),
            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_account.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="SUBSCRIPTION_ID",
    )

    response = client.invoices.begin_download_documents_by_billing_account(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        parameters=[
            {"documentName": "12345678", "invoiceName": "G123456789"},
            {"documentName": "12345678", "invoiceName": "G987654321"},
        ],
    ).result()
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingAccount.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/invoicesDownloadDocumentsByBillingAccount.json
func ExampleInvoicesClient_BeginDownloadDocumentsByBillingAccount() {
	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().BeginDownloadDocumentsByBillingAccount(ctx, "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", []*armbilling.DocumentDownloadRequest{
		{
			DocumentName: to.Ptr("12345678"),
			InvoiceName:  to.Ptr("G123456789"),
		},
		{
			DocumentName: to.Ptr("12345678"),
			InvoiceName:  to.Ptr("G987654321"),
		}}, 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/invoicesDownloadDocumentsByBillingAccount.json
 */
async function invoicesDownloadDocumentsByBillingAccount() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const parameters = [
    { documentName: "12345678", invoiceName: "G123456789" },
    { documentName: "12345678", invoiceName: "G987654321" },
  ];
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.invoices.beginDownloadDocumentsByBillingAccountAndWait(
    billingAccountName,
    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.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesDownloadDocumentsByBillingAccount.json
// this example is just showing the usage of "Invoices_DownloadDocumentsByBillingAccount" 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);

// this example assumes you already have this BillingAccountResource created on azure
// for more information of creating BillingAccountResource, please refer to the document of BillingAccountResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
ResourceIdentifier billingAccountResourceId = BillingAccountResource.CreateResourceIdentifier(billingAccountName);
BillingAccountResource billingAccount = client.GetBillingAccountResource(billingAccountResourceId);

// invoke the operation
IEnumerable<BillingDocumentDownloadRequestContent> arrayOfDocumentDownloadRequest = new BillingDocumentDownloadRequestContent[]
{
new BillingDocumentDownloadRequestContent
{
DocumentName = "12345678",
InvoiceName = "G123456789",
},
new BillingDocumentDownloadRequestContent
{
DocumentName = "12345678",
InvoiceName = "G987654321",
}
};
ArmOperation<BillingDocumentDownloadResult> lro = await billingAccount.DownloadDocumentsByBillingAccountInvoiceAsync(WaitUntil.Completed, 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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Kod stanu:: 202

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

Definicje

Nazwa	Opis
DocumentDownloadRequest	Lista szczegółów pobierania poszczególnych dokumentów.
DocumentDownloadResult	Bezpieczny adres URL, który może służyć do pobierania jednostki do momentu wygaśnięcia adresu URL.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd

DocumentDownloadRequest

Objekt

Lista szczegółów pobierania poszczególnych dokumentów.

Nazwa	Typ	Opis
documentName	string	Identyfikator, który jednoznacznie identyfikuje dokument faktury. Ten identyfikator może być identyfikatorem pliku PDF faktury, noty kredytowej lub paragonu podatkowego. W przypadku pominięcia zostanie zwrócony najnowszy plik PDF faktury dla faktury.
invoiceName	string	Identyfikator, który jednoznacznie identyfikuje fakturę.

DocumentDownloadResult

Objekt

Bezpieczny adres URL, który może służyć do pobierania jednostki do momentu wygaśnięcia adresu URL.

Nazwa	Typ	Opis
expiryTime	string	Godzina w formacie UTC, kiedy adres URL pobierania wygaśnie.
url	string	Adres URL pliku PDF lub .zip.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.