Invoices - Get By Id

參考

Service:: Billing

API Version:: 2020-05-01

依標識碼取得發票。合約類型為 Microsoft 合作夥伴合約或 Microsoft 客戶合約的計費帳戶支援此作業。

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

URI 參數

名稱	位於	必要	類型	Description
invoiceName	path	True	string	可唯一識別發票的標識碼。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。目前的版本是 2020-05-01。

回應

名稱	類型	Description
200 OK	Invoice	正常。要求成功。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

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

定義

名稱	Description
Amount	金額。
Document	檔的屬性。
DocumentSource	檔的來源。適用於巴西的 ENF 和全球其餘部分的 DRS。
DocumentType	文件的類型。
ErrorDetails	錯誤的詳細數據。
ErrorResponse	錯誤回應表示服務無法處理傳入要求。錯誤訊息中提供了原因。
ErrorSubDetails
Invoice	發票。
InvoiceDocumentType	文件的類型。
InvoiceStatus	發票的目前狀態。
InvoiceType	發票類型。
PaymentMethodFamily	付款方式系列。
PaymentProperties	付款的屬性。
RebillDetails	發票的重新計費詳細數據。

Amount

金額。

名稱	類型	Description
currency	string	金額值的貨幣。
value	number	金額值。

Document

檔的屬性。

名稱	類型	Description
kind	DocumentType	文件的類型。
source	DocumentSource	檔的來源。適用於巴西的 ENF 和全球其餘部分的 DRS。
url	string	檔 URL。

DocumentSource

檔的來源。適用於巴西的 ENF 和全球其餘部分的 DRS。

名稱	類型	Description
DRS	string
ENF	string

DocumentType

文件的類型。

名稱	類型	Description
CreditNote	string
Invoice	string
TaxReceipt	string
VoidNote	string

ErrorDetails

錯誤的詳細數據。

名稱	類型	Description
code	string	錯誤碼。
details	ErrorSubDetails[]	錯誤的子詳細數據。
message	string	指出作業失敗原因的錯誤訊息。
target	string	特定錯誤的目標。

ErrorResponse

錯誤回應表示服務無法處理傳入要求。錯誤訊息中提供了原因。

名稱	類型	Description
error	ErrorDetails	錯誤的詳細數據。

ErrorSubDetails

名稱	類型	Description
code	string	錯誤碼。
message	string	指出作業失敗原因的錯誤訊息。
target	string	特定錯誤的目標。

Invoice

發票。

名稱	類型	Description
id	string	資源標識碼。
name	string	資源名稱。
properties.amountDue	Amount	目前到期金額。
properties.azurePrepaymentApplied	Amount	套用至費用的 Azure 預付款金額。此欄位適用於合約類型為 Microsoft 客戶合約的計費帳戶。
properties.billedAmount	Amount	發票計費週期的總費用。
properties.billedDocumentId	string	使用中發票的標識碼，此發票最初會在此發票過期之後計費。此欄位僅適用於 void 發票。
properties.billingProfileDisplayName	string	產生發票的帳單配置檔名稱。
properties.billingProfileId	string	產生發票之帳單配置檔的標識碼。
properties.creditAmount	Amount	發票計費期間傳回和取消的總退款。此欄位適用於合約類型為 Microsoft 客戶合約的計費帳戶。
properties.creditForDocumentId	string	發票的標識碼已失效，且此點數附注會因為結果而發行。此欄位僅適用於信用額度。
properties.documentType	InvoiceDocumentType	文件的類型。
properties.documents	Document[]	可供下載的檔清單，例如發票和稅務收據。
properties.dueDate	string	發票的到期日。
properties.freeAzureCreditApplied	Amount	套用至費用的免費 Azure 點數金額。此欄位適用於合約類型為 Microsoft 客戶合約的計費帳戶。
properties.invoiceDate	string	產生發票的日期。
properties.invoicePeriodEndDate	string	產生發票之計費週期的結束日期。
properties.invoicePeriodStartDate	string	產生發票之計費週期的開始日期。
properties.invoiceType	InvoiceType	發票類型。
properties.isMonthlyInvoice	boolean	指定發票是否產生為每月發票週期的一部分。此欄位適用於合約類型為 Microsoft 客戶合約的計費帳戶。
properties.payments	PaymentProperties[]	付款清單。
properties.purchaseOrderNumber	string	發票的選擇性採購單號碼。
properties.rebillDetails	<string, RebillDetails>	發票的重新計費詳細數據。
properties.status	InvoiceStatus	發票的目前狀態。
properties.subTotal	Amount	稅前金額到期。此欄位適用於合約類型為 Microsoft 客戶合約的計費帳戶。
properties.subscriptionId	string	產生發票之訂用帳戶的標識碼。
properties.taxAmount	Amount	計費期間所收取的稅金金額。此欄位適用於合約類型為 Microsoft 客戶合約的計費帳戶。
properties.totalAmount	Amount	產生發票時所到期的金額。此欄位適用於合約類型為 Microsoft 客戶合約的計費帳戶。
type	string	資源類型。

InvoiceDocumentType

文件的類型。

名稱	類型	Description
CreditNote	string
Invoice	string

InvoiceStatus

發票的目前狀態。

名稱	類型	Description
Due	string
OverDue	string
Paid	string
Void	string

InvoiceType

發票類型。

名稱	類型	Description
AzureMarketplace	string
AzureService	string
AzureSupport	string

PaymentMethodFamily

付款方式系列。

名稱	類型	Description
CheckWire	string
CreditCard	string
Credits	string
None	string

PaymentProperties

付款的屬性。

名稱	類型	Description
amount	Amount	付費金額。
date	string	付款的日期。
paymentMethodFamily	PaymentMethodFamily	付款方式系列。
paymentMethodType	string	付款方式的類型。
paymentType	string	付款的類型。

RebillDetails

發票的重新計費詳細數據。

名稱	類型	Description
creditNoteDocumentId	string	點數記事的標識碼。
invoiceDocumentId	string	發票的標識碼。
rebillDetails	<string, RebillDetails>	發票的重新計費詳細數據。

Invoices - Get By Id

URI 參數

回應

安全性

azure_auth

Scopes

範例

Invoice

Sample Request

Sample Response

定義

Amount

Document

DocumentSource

DocumentType

ErrorDetails

ErrorResponse

ErrorSubDetails

Invoice

InvoiceDocumentType

InvoiceStatus

InvoiceType

PaymentMethodFamily

PaymentProperties

RebillDetails

其他資源