Invoices - Get By Subscription And Invoice Id

Riferimento

Service:: Billing

API Version:: 2020-05-01

Ottiene una fattura in base all'ID sottoscrizione e all'ID fattura.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
invoiceName	path	True	string	ID che identifica in modo univoco una fattura.
subscriptionId	path	True	string	ID che identifica in modo univoco una sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API da usare con la richiesta client. La versione corrente è 2020-05-01.

Risposte

Nome	Tipo	Descrizione
200 OK	Invoice	OK. La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

BillingSubscriptionsListByBillingAccount

Sample Request

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

/** Samples for Invoices GetBySubscriptionAndInvoiceId. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoice.json
     */
    /**
     * Sample code: BillingSubscriptionsListByBillingAccount.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void billingSubscriptionsListByBillingAccount(
        com.azure.resourcemanager.billing.BillingManager manager) {
        manager.invoices().getBySubscriptionAndInvoiceIdWithResponse("{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/BillingSubscriptionInvoice.json
func ExampleInvoicesClient_GetBySubscriptionAndInvoiceID() {
	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().GetBySubscriptionAndInvoiceID(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("1383724"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/billingSubscriptions/invoices"),
	// 	ID: to.Ptr("providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724"),
	// 	Properties: &armbilling.InvoiceProperties{
	// 		AmountDue: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](2000),
	// 		},
	// 		BilledAmount: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](2000),
	// 		},
	// 		BillingProfileDisplayName: to.Ptr("Contoso Operations Billing"),
	// 		BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000"),
	// 		Documents: []*armbilling.Document{
	// 			{
	// 				Kind: to.Ptr(armbilling.DocumentTypeInvoice),
	// 				Source: to.Ptr(armbilling.DocumentSourceDRS),
	// 				URL: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724/download"),
	// 		}},
	// 		DueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-01T17:32:28.000Z"); return t}()),
	// 		InvoiceDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-01T17:32:28.000Z"); return t}()),
	// 		InvoicePeriodEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-02T17:32:28.000Z"); return t}()),
	// 		InvoicePeriodStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-01T17:32:28.000Z"); return t}()),
	// 		InvoiceType: to.Ptr(armbilling.InvoiceTypeAzureMarketplace),
	// 		Payments: []*armbilling.PaymentProperties{
	// 			{
	// 				Amount: &armbilling.Amount{
	// 					Currency: to.Ptr("USD"),
	// 					Value: to.Ptr[float32](2000),
	// 				},
	// 				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.InvoiceStatusPaid),
	// 		SubscriptionID: to.Ptr("55000000-0000-0000-0000-000000000011"),
	// 	},
	// }
}

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 subscription ID and invoice ID.
 *
 * @summary Gets an invoice by subscription ID and invoice ID.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoice.json
 */
async function billingSubscriptionsListByBillingAccount() {
  const subscriptionId = "{subscriptionId}";
  const invoiceName = "{invoiceName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.invoices.getBySubscriptionAndInvoiceId(invoiceName);
  console.log(result);
}

billingSubscriptionsListByBillingAccount().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}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724",
  "name": "1383724",
  "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices",
  "properties": {
    "dueDate": "2022-03-01T17:32:28Z",
    "invoiceDate": "2022-01-01T17:32:28Z",
    "status": "Paid",
    "amountDue": {
      "currency": "USD",
      "value": 2000
    },
    "billedAmount": {
      "currency": "USD",
      "value": 2000
    },
    "invoicePeriodStartDate": "2022-01-01T17:32:28Z",
    "invoicePeriodEndDate": "2022-01-30T17:32:28Z",
    "invoiceType": "AzureMarketplace",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
    "billingProfileDisplayName": "Contoso Operations Billing",
    "purchaseOrderNumber": "123456",
    "documents": [
      {
        "kind": "Invoice",
        "url": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724/download",
        "source": "DRS"
      }
    ],
    "payments": [
      {
        "date": "2018-01-14T17:32:28Z",
        "paymentType": "credited",
        "amount": {
          "currency": "USD",
          "value": 2000
        },
        "paymentMethodFamily": "CreditCard",
        "paymentMethodType": "visa"
      }
    ],
    "subscriptionId": "55000000-0000-0000-0000-000000000011"
  }
}

Definizioni

Nome	Descrizione
Amount	Importo.
Document	Proprietà di un documento.
DocumentSource	Origine del documento. ENF per Brasile e DRS per il resto del mondo.
DocumentType	Tipo del documento.
ErrorDetails	Dettagli dell'errore.
ErrorResponse	Risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.
ErrorSubDetails
Invoice	Fattura.
InvoiceDocumentType	Tipo del documento.
InvoiceStatus	Stato corrente della fattura.
InvoiceType	Tipo di fattura.
PaymentMethodFamily	Famiglia di metodi di pagamento.
PaymentProperties	Proprietà di un pagamento.
RebillDetails	Dettagli della fattura.

Amount

Importo.

Nome	Tipo	Descrizione
currency	string	Valuta per il valore dell'importo.
value	number	Valore quantità.

Document

Proprietà di un documento.

Nome	Tipo	Descrizione
kind	DocumentType	Tipo del documento.
source	DocumentSource	Origine del documento. ENF per Brasile e DRS per il resto del mondo.
url	string	URL documento.

DocumentSource

Origine del documento. ENF per Brasile e DRS per il resto del mondo.

Nome	Tipo	Descrizione
DRS	string
ENF	string

DocumentType

Tipo del documento.

Nome	Tipo	Descrizione
CreditNote	string
Invoice	string
TaxReceipt	string
VoidNote	string

ErrorDetails

Dettagli dell'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	ErrorSubDetails[]	Dettagli secondari dell'errore.
message	string	Messaggio di errore che indica perché l'operazione non è riuscita.
target	string	Destinazione dell'errore specifico.

ErrorResponse

Risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore.

ErrorSubDetails

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore che indica perché l'operazione non è riuscita.
target	string	Destinazione dell'errore specifico.

Invoice

Fattura.

Nome	Tipo	Descrizione
id	string	ID risorsa.
name	string	Nome risorsa.
properties.amountDue	Amount	Importo dovuto a questo momento.
properties.azurePrepaymentApplied	Amount	Importo del pagamento anticipato di Azure applicato agli addebiti. Questo campo è applicabile agli account di fatturazione con il tipo di contratto Contratto del cliente Microsoft.
properties.billedAmount	Amount	Addebiti totali per il periodo di fatturazione della fattura.
properties.billedDocumentId	string	ID della fattura attiva fatturata originariamente dopo che questa fattura è stata annullata. Questo campo è applicabile solo alle fatture void.
properties.billingProfileDisplayName	string	Nome del profilo di fatturazione per il quale viene generata la fattura.
properties.billingProfileId	string	ID del profilo di fatturazione per il quale viene generata la fattura.
properties.creditAmount	Amount	Rimborso totale per i restituzioni e gli annullamenti durante il periodo di fatturazione della fattura. Questo campo è applicabile agli account di fatturazione con il tipo di contratto Contratto del cliente Microsoft.
properties.creditForDocumentId	string	Id della fattura che è stata annullata e questa nota di credito è stata emessa di conseguenza. Questo campo è applicabile solo alle note di credito.
properties.documentType	InvoiceDocumentType	Tipo del documento.
properties.documents	Document[]	Elenco di documenti disponibili per scaricare, ad esempio la fattura e la ricevuta fiscale.
properties.dueDate	string	Data di scadenza della fattura.
properties.freeAzureCreditApplied	Amount	Importo di crediti di Azure gratuiti applicati agli addebiti. Questo campo è applicabile agli account di fatturazione con il tipo di contratto Contratto del cliente Microsoft.
properties.invoiceDate	string	Data di generazione della fattura.
properties.invoicePeriodEndDate	string	Data di fine del periodo di fatturazione per cui viene generata la fattura.
properties.invoicePeriodStartDate	string	Data di inizio del periodo di fatturazione per cui viene generata la fattura.
properties.invoiceType	InvoiceType	Tipo di fattura.
properties.isMonthlyInvoice	boolean	Specifica se la fattura viene generata come parte del ciclo di fatturazione mensile o meno. Questo campo è applicabile agli account di fatturazione con il tipo di contratto Contratto del cliente Microsoft.
properties.payments	PaymentProperties[]	Elenco dei pagamenti.
properties.purchaseOrderNumber	string	Numero di ordine di acquisto facoltativo per la fattura.
properties.rebillDetails	<string, RebillDetails>	Dettagli della fattura.
properties.status	InvoiceStatus	Stato corrente della fattura.
properties.subTotal	Amount	Importo pre-imposta dovuto. Questo campo è applicabile agli account di fatturazione con il tipo di contratto Contratto del cliente Microsoft.
properties.subscriptionId	string	ID della sottoscrizione per cui viene generata la fattura.
properties.taxAmount	Amount	Importo dell'imposta addebitata per il periodo di fatturazione. Questo campo è applicabile agli account di fatturazione con il tipo di contratto Contratto del cliente Microsoft.
properties.totalAmount	Amount	Importo dovuto al momento della generazione della fattura. Questo campo è applicabile agli account di fatturazione con il tipo di contratto Contratto del cliente Microsoft.
type	string	Tipo di risorsa.

InvoiceDocumentType

Tipo del documento.

Nome	Tipo	Descrizione
CreditNote	string
Invoice	string

InvoiceStatus

Stato corrente della fattura.

Nome	Tipo	Descrizione
Due	string
OverDue	string
Paid	string
Void	string

InvoiceType

Tipo di fattura.

Nome	Tipo	Descrizione
AzureMarketplace	string
AzureService	string
AzureSupport	string

PaymentMethodFamily

Famiglia di metodi di pagamento.

Nome	Tipo	Descrizione
CheckWire	string
CreditCard	string
Credits	string
None	string

PaymentProperties

Proprietà di un pagamento.

Nome	Tipo	Descrizione
amount	Amount	Importo pagato.
date	string	Data in cui è stato effettuato il pagamento.
paymentMethodFamily	PaymentMethodFamily	Famiglia di metodi di pagamento.
paymentMethodType	string	Tipo di metodo di pagamento.
paymentType	string	Tipo di pagamento.

RebillDetails

Dettagli della fattura.

Nome	Tipo	Descrizione
creditNoteDocumentId	string	ID della nota di credito.
invoiceDocumentId	string	ID della fattura.
rebillDetails	<string, RebillDetails>	Dettagli della fattura.

Condividi tramite

Invoices - Get By Subscription And Invoice Id

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Scopes

Esempio

BillingSubscriptionsListByBillingAccount

Sample Request

Sample Response

Definizioni

Amount

Document

DocumentSource

DocumentType

ErrorDetails

ErrorResponse

ErrorSubDetails

Invoice

InvoiceDocumentType

InvoiceStatus

InvoiceType

PaymentMethodFamily

PaymentProperties

RebillDetails

Risorse aggiuntive