Invoices - Get By Id

Odwołanie

Service:: Billing

API Version:: 2020-05-01

Pobiera fakturę według identyfikatora. Ta operacja jest obsługiwana w przypadku kont rozliczeniowych z typem umowy Microsoft Partner Agreement lub Umowa z Klientem Microsoft.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/invoices/{invoiceName}?api-version=2020-05-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
invoiceName	path	True	string	Identyfikator, który jednoznacznie identyfikuje fakturę.
api-version	query	True	string	Wersja interfejsu API, która ma być używana z żądaniem klienta. Bieżąca wersja to 2020-05-01.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Invoice	OK. Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Invoice

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/invoices/{invoiceName}?api-version=2020-05-01

/** Samples for Invoices GetById. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceById.json
     */
    /**
     * Sample code: Invoice.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void invoice(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.invoices().getByIdWithResponse("{invoiceName}", 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

package armbilling_test

import (
	"context"
	"log"

	"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/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceById.json
func ExampleInvoicesClient_GetByID() {
	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)
	}
	res, err := clientFactory.NewInvoicesClient().GetByID(ctx, "{invoiceName}", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.Invoice = armbilling.Invoice{
	// 	Name: to.Ptr("{invoiceName}"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/invoices"),
	// 	ID: to.Ptr("providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}"),
	// 	Properties: &armbilling.InvoiceProperties{
	// 		AmountDue: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](16.53),
	// 		},
	// 		AzurePrepaymentApplied: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](15.46),
	// 		},
	// 		BilledAmount: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](33.99),
	// 		},
	// 		BillingProfileDisplayName: to.Ptr("Contoso Operations Billing"),
	// 		BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}"),
	// 		CreditAmount: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](2),
	// 		},
	// 		Documents: []*armbilling.Document{
	// 			{
	// 				Kind: to.Ptr(armbilling.DocumentTypeInvoice),
	// 				Source: to.Ptr(armbilling.DocumentSourceDRS),
	// 				URL: to.Ptr("https://microsoft.com/invoice.pdf"),
	// 			},
	// 			{
	// 				Kind: to.Ptr(armbilling.DocumentTypeTaxReceipt),
	// 				Source: to.Ptr(armbilling.DocumentSourceDRS),
	// 				URL: to.Ptr("https://microsoft.com/taxDoc.pdf"),
	// 		}},
	// 		DueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-16T17:32:28.000Z"); return t}()),
	// 		FreeAzureCreditApplied: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](0),
	// 		},
	// 		InvoiceDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-01T17:32:28.000Z"); return t}()),
	// 		InvoicePeriodEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-15T17:32:28.000Z"); return t}()),
	// 		InvoicePeriodStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-01T17:32:28.000Z"); return t}()),
	// 		IsMonthlyInvoice: to.Ptr(false),
	// 		Payments: []*armbilling.PaymentProperties{
	// 			{
	// 				Amount: &armbilling.Amount{
	// 					Currency: to.Ptr("USD"),
	// 					Value: to.Ptr[float32](2),
	// 				},
	// 				Date: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-14T17:32:28.000Z"); return t}()),
	// 				PaymentMethodFamily: to.Ptr(armbilling.PaymentMethodFamilyCreditCard),
	// 				PaymentMethodType: to.Ptr("visa"),
	// 				PaymentType: to.Ptr("credited"),
	// 		}},
	// 		PurchaseOrderNumber: to.Ptr("123456"),
	// 		Status: to.Ptr(armbilling.InvoiceStatusDue),
	// 		SubTotal: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](33.99),
	// 		},
	// 		TaxAmount: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](0),
	// 		},
	// 		TotalAmount: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](16.53),
	// 		},
	// 	},
	// }
}

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 an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
 *
 * @summary Gets an invoice by ID. 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/2020-05-01/examples/InvoiceById.json
 */
async function invoice() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const invoiceName = "{invoiceName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.invoices.getById(invoiceName);
  console.log(result);
}

invoice().catch(console.error);

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

Sample Response

Status code:: 200

{
  "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}",
  "name": "{invoiceName}",
  "type": "Microsoft.Billing/billingAccounts/invoices",
  "properties": {
    "dueDate": "2018-01-16T17:32:28Z",
    "invoiceDate": "2018-01-01T17:32:28Z",
    "status": "Due",
    "amountDue": {
      "currency": "USD",
      "value": 16.53
    },
    "billedAmount": {
      "currency": "USD",
      "value": 33.99
    },
    "azurePrepaymentApplied": {
      "currency": "USD",
      "value": 15.46
    },
    "creditAmount": {
      "currency": "USD",
      "value": 2
    },
    "freeAzureCreditApplied": {
      "currency": "USD",
      "value": 0
    },
    "subTotal": {
      "currency": "USD",
      "value": 33.99
    },
    "taxAmount": {
      "currency": "USD",
      "value": 0
    },
    "totalAmount": {
      "currency": "USD",
      "value": 16.53
    },
    "invoicePeriodStartDate": "2018-01-01T17:32:28Z",
    "invoicePeriodEndDate": "2018-01-15T17:32:28Z",
    "isMonthlyInvoice": false,
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
    "billingProfileDisplayName": "Contoso Operations Billing",
    "purchaseOrderNumber": "123456",
    "documents": [
      {
        "kind": "Invoice",
        "url": "https://microsoft.com/invoice.pdf",
        "source": "DRS"
      },
      {
        "kind": "TaxReceipt",
        "url": "https://microsoft.com/taxDoc.pdf",
        "source": "DRS"
      }
    ],
    "payments": [
      {
        "date": "2018-01-14T17:32:28Z",
        "paymentType": "credited",
        "amount": {
          "currency": "USD",
          "value": 2
        },
        "paymentMethodFamily": "CreditCard",
        "paymentMethodType": "visa"
      }
    ]
  }
}

Definicje

Nazwa	Opis
Amount	Kwota.
Document	Właściwości dokumentu.
DocumentSource	Źródło dokumentu. ENF dla Brazylii i DRS dla reszty świata.
DocumentType	Typ dokumentu.
ErrorDetails	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.
ErrorSubDetails
Invoice	Faktura.
InvoiceDocumentType	Typ dokumentu.
InvoiceStatus	Bieżący stan faktury.
InvoiceType	Typ faktury.
PaymentMethodFamily	Rodzina formy płatności.
PaymentProperties	Właściwości płatności.
RebillDetails	Szczegóły ponownego wysyłania faktury.

Amount

Kwota.

Nazwa	Typ	Opis
currency	string	Waluta dla wartości kwoty.
value	number	Wartość kwoty.

Document

Właściwości dokumentu.

Nazwa	Typ	Opis
kind	DocumentType	Typ dokumentu.
source	DocumentSource	Źródło dokumentu. ENF dla Brazylii i DRS dla reszty świata.
url	string	Adres URL dokumentu.

DocumentSource

Źródło dokumentu. ENF dla Brazylii i DRS dla reszty świata.

Nazwa	Typ	Opis
DRS	string
ENF	string

DocumentType

Typ dokumentu.

Nazwa	Typ	Opis
CreditNote	string
Invoice	string
TaxReceipt	string
VoidNote	string

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ErrorSubDetails[]	Szczegóły podrzędne błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.
target	string	Element docelowy określonego błędu.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu.

ErrorSubDetails

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.
target	string	Element docelowy określonego błędu.

Invoice

Faktura.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.amountDue	Amount	Kwota należna od teraz.
properties.azurePrepaymentApplied	Amount	Kwota przedpłaty za platformę Azure zastosowana do opłat. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.
properties.billedAmount	Amount	Łączne opłaty za okres rozliczeniowy faktury.
properties.billedDocumentId	string	Identyfikator aktywnej faktury, która jest pierwotnie rozliczana po unieważnieniu faktury. To pole ma zastosowanie tylko do faktur unieważnianych.
properties.billingProfileDisplayName	string	Nazwa profilu rozliczeniowego, dla którego jest generowana faktura.
properties.billingProfileId	string	Identyfikator profilu rozliczeniowego, dla którego jest generowana faktura.
properties.creditAmount	Amount	Łączny zwrot kosztów zwrotów i anulowania w okresie rozliczeniowym faktury. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.
properties.creditForDocumentId	string	Identyfikator faktury, która została unieważniona, a ta notatka kredytowa została wystawiona w wyniku. To pole ma zastosowanie tylko do notatek kredytowych.
properties.documentType	InvoiceDocumentType	Typ dokumentu.
properties.documents	Document[]	Lista dokumentów dostępnych do pobrania, takich jak faktura i paragon podatkowy.
properties.dueDate	string	Data ukończenia faktury.
properties.freeAzureCreditApplied	Amount	Kwota bezpłatnych środków na korzystanie z platformy Azure zastosowana do opłat. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.
properties.invoiceDate	string	Data wygenerowania faktury.
properties.invoicePeriodEndDate	string	Data zakończenia okresu rozliczeniowego, dla którego jest generowana faktura.
properties.invoicePeriodStartDate	string	Data rozpoczęcia okresu rozliczeniowego, dla którego jest generowana faktura.
properties.invoiceType	InvoiceType	Typ faktury.
properties.isMonthlyInvoice	boolean	Określa, czy faktura jest generowana w ramach miesięcznego cyklu fakturowania, czy nie. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.
properties.payments	PaymentProperties[]	Lista płatności.
properties.purchaseOrderNumber	string	Opcjonalny numer zamówienia zakupu dla faktury.
properties.rebillDetails	<string, RebillDetails>	Szczegóły ponownego wysyłania faktury.
properties.status	InvoiceStatus	Bieżący stan faktury.
properties.subTotal	Amount	Należna kwota przed opodatkowaniem. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.
properties.subscriptionId	string	Identyfikator subskrypcji, dla której jest generowana faktura.
properties.taxAmount	Amount	Kwota podatku naliczonego w okresie rozliczeniowym. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.
properties.totalAmount	Amount	Kwota należna podczas generowania faktury. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.
type	string	Typ zasobu.

InvoiceDocumentType

Typ dokumentu.

Nazwa	Typ	Opis
CreditNote	string
Invoice	string

InvoiceStatus

Bieżący stan faktury.

Nazwa	Typ	Opis
Due	string
OverDue	string
Paid	string
Void	string

InvoiceType

Typ faktury.

Nazwa	Typ	Opis
AzureMarketplace	string
AzureService	string
AzureSupport	string

PaymentMethodFamily

Rodzina formy płatności.

Nazwa	Typ	Opis
CheckWire	string
CreditCard	string
Credits	string
None	string

PaymentProperties

Właściwości płatności.

Nazwa	Typ	Opis
amount	Amount	Zapłacona kwota.
date	string	Data dokonania płatności.
paymentMethodFamily	PaymentMethodFamily	Rodzina formy płatności.
paymentMethodType	string	Typ formy płatności.
paymentType	string	Typ płatności.

RebillDetails

Szczegóły ponownego wysyłania faktury.

Nazwa	Typ	Opis
creditNoteDocumentId	string	Identyfikator noty kredytowej.
invoiceDocumentId	string	Identyfikator faktury.
rebillDetails	<string, RebillDetails>	Szczegóły ponownego wysyłania faktury.

Share via

Invoices - Get By Id

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

Invoice

Sample Request

Sample Response

Definicje

Amount

Document

DocumentSource

DocumentType

ErrorDetails

ErrorResponse

ErrorSubDetails

Invoice

InvoiceDocumentType

InvoiceStatus

InvoiceType

PaymentMethodFamily

PaymentProperties

RebillDetails

Dodatkowe zasoby