你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Invoices - Get By Id

参考

Service:: Billing

API Version:: 2020-05-01

按 ID 获取发票。协议类型为 Microsoft 合作伙伴协议或 Microsoft 客户协议的计费帐户支持该操作。

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

URI 参数

名称	在	必需	类型	说明
invoiceName	path	True	string	唯一标识发票的 ID。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。当前版本为 2020-05-01。

响应

名称	类型	说明
200 OK	Invoice	没问题。请求已成功。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

Scopes

名称	说明
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"
      }
    ]
  }
}

定义

名称	说明
Amount	金额。
Document	文档的属性。
DocumentSource	文档的源。 ENF 为巴西，DRS 为世界其他地区。
DocumentType	文档的类型。
ErrorDetails	错误的详细信息。
ErrorResponse	错误响应指示服务无法处理传入请求。错误消息中提供了原因。
ErrorSubDetails
Invoice	发票。
InvoiceDocumentType	文档的类型。
InvoiceStatus	发票的当前状态。
InvoiceType	发票类型。
PaymentMethodFamily	付款方式系列。
PaymentProperties	付款的属性。
RebillDetails	发票的重新计费详细信息。

Amount

金额。

名称	类型	说明
currency	string	金额值的货币。
value	number	金额值。

Document

文档的属性。

名称	类型	说明
kind	DocumentType	文档的类型。
source	DocumentSource	文档的源。 ENF 为巴西，DRS 为世界其他地区。
url	string	文档 URL。

DocumentSource

文档的源。 ENF 为巴西，DRS 为世界其他地区。

名称	类型	说明
DRS	string
ENF	string

DocumentType

文档的类型。

名称	类型	说明
CreditNote	string
Invoice	string
TaxReceipt	string
VoidNote	string

ErrorDetails

错误的详细信息。

名称	类型	说明
code	string	错误代码。
details	ErrorSubDetails[]	错误的子详细信息。
message	string	指示操作失败原因的错误消息。
target	string	特定错误的目标。

ErrorResponse

错误响应指示服务无法处理传入请求。错误消息中提供了原因。

名称	类型	说明
error	ErrorDetails	错误的详细信息。

ErrorSubDetails

名称	类型	说明
code	string	错误代码。
message	string	指示操作失败原因的错误消息。
target	string	特定错误的目标。

Invoice

发票。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.amountDue	Amount	截至目前到期的金额。
properties.azurePrepaymentApplied	Amount	应用于费用的 Azure 预付款金额。此字段适用于协议类型为 Microsoft 客户协议的计费帐户。
properties.billedAmount	Amount	发票计费周期的总费用。
properties.billedDocumentId	string	此发票失效后最初计费的活动发票的 ID。此字段仅适用于无效发票。
properties.billingProfileDisplayName	string	为其生成发票的计费对象信息的名称。
properties.billingProfileId	string	为其生成发票的计费对象信息的 ID。
properties.creditAmount	Amount	发票计费周期内退货和取消的总退款。此字段适用于协议类型为 Microsoft 客户协议的计费帐户。
properties.creditForDocumentId	string	发票的 ID 已作废，因此已开具此信用单。此字段仅适用于信用票据。
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	为其生成发票的订阅的 ID。
properties.taxAmount	Amount	计费周期的税款金额。此字段适用于协议类型为 Microsoft 客户协议的计费帐户。
properties.totalAmount	Amount	生成发票时到期的金额。此字段适用于协议类型为 Microsoft 客户协议的计费帐户。
type	string	资源类型。

InvoiceDocumentType

文档的类型。

名称	类型	说明
CreditNote	string
Invoice	string

InvoiceStatus

发票的当前状态。

名称	类型	说明
Due	string
OverDue	string
Paid	string
Void	string

InvoiceType

发票类型。

名称	类型	说明
AzureMarketplace	string
AzureService	string
AzureSupport	string

PaymentMethodFamily

付款方式系列。

名称	类型	说明
CheckWire	string
CreditCard	string
Credits	string
None	string

PaymentProperties

付款的属性。

名称	类型	说明
amount	Amount	付费金额。
date	string	付款的日期。
paymentMethodFamily	PaymentMethodFamily	付款方式系列。
paymentMethodType	string	付款方式的类型。
paymentType	string	付款类型。

RebillDetails

发票的重新计费详细信息。

名称	类型	说明
creditNoteDocumentId	string	信用票据的 ID。
invoiceDocumentId	string	发票的 ID。
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

其他资源