Invoices - List By Billing Subscription

參考

服務:: Billing

API 版本:: 2024-04-01

列出訂用帳戶的發票。

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

含選擇性參數:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices?periodStartDate={periodStartDate}&periodEndDate={periodEndDate}&api-version=2024-04-01&filter={filter}&orderBy={orderBy}&top={top}&skip={skip}&count={count}&search={search}

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	可唯一識別計費訂用帳戶的標識碼。 Regex 模式: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。目前的版本是 2024-04-01。
count	query		boolean	count 查詢選項可讓用戶端要求響應中資源隨附的相符資源計數。
filter	query		string	篩選查詢選項可讓客戶端篩選要求URL所尋址的資源集合。
orderBy	query		string	orderby 查詢選項可讓用戶端以特定順序要求資源。
periodEndDate	query		string date	產生發票之計費週期的結束日期。日期的格式為MM-DD-YYYY。
periodStartDate	query		string date	產生發票之計費週期的開始日期。日期的格式為MM-DD-YYYY。
search	query		string	搜尋查詢選項可讓用戶端要求集合內符合自由文字搜尋表達式的專案。僅支援字串欄位的搜尋。
skip	query		integer int64	skip 查詢選項會要求要略過且不包含在結果中的查詢集合中的項目數目。
top	query		integer int64	最上層查詢選項會要求結果中包含查詢集合中的項目數目。頂端支援的最大值為 50。

回應

名稱	類型	Description
200 OK	InvoiceListResult	發票清單。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

範例

InvoicesListByBillingSubscription

範例要求

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices?periodStartDate=2023-01-01&periodEndDate=2023-06-30&api-version=2024-04-01

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/E123456789",
      "name": "E123456789",
      "properties": {
        "amountDue": {
          "currency": "USD",
          "value": 8.53
        },
        "billedAmount": {
          "currency": "USD",
          "value": 33.99
        },
        "dueDate": "2023-02-16T17:32:28Z",
        "invoiceDate": "2023-02-01T17:32:28Z",
        "invoicePeriodEndDate": "2023-02-15T17:32:28Z",
        "invoicePeriodStartDate": "2023-02-01T17:32:28Z",
        "invoiceType": "AzureServices",
        "purchaseOrderNumber": "123456",
        "status": "Due",
        "subscriptionDisplayName": "Contoso Operations Billing",
        "subscriptionId": "11111111-1111-1111-1111-111111111111"
      },
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/G123456789",
      "name": "G123456789",
      "properties": {
        "amountDue": {
          "currency": "USD",
          "value": 15.53
        },
        "billedAmount": {
          "currency": "USD",
          "value": 55.99
        },
        "dueDate": "2023-02-16T17:32:28Z",
        "invoiceDate": "2023-02-01T17:32:28Z",
        "invoicePeriodEndDate": "2023-02-15T17:32:28Z",
        "invoicePeriodStartDate": "2023-02-01T17:32:28Z",
        "invoiceType": "AzureMarketplace",
        "purchaseOrderNumber": "123456",
        "status": "Due",
        "subscriptionDisplayName": "Contoso Operations Billing",
        "subscriptionId": "11111111-1111-1111-1111-111111111111"
      },
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11111111-1111-1111-1111-111111111111/invoices/E987654321",
      "name": "E987654321",
      "properties": {
        "amountDue": {
          "currency": "USD",
          "value": 8.53
        },
        "billedAmount": {
          "currency": "USD",
          "value": 33.99
        },
        "documents": [
          {
            "kind": "Invoice",
            "name": "12345678"
          }
        ],
        "dueDate": "2023-01-16T17:32:28Z",
        "invoiceDate": "2023-01-01T17:32:28Z",
        "invoicePeriodEndDate": "2023-01-15T17:32:28Z",
        "invoicePeriodStartDate": "2023-01-01T17:32:28Z",
        "invoiceType": "AzureSupport",
        "payments": [
          {
            "amount": {
              "currency": "USD",
              "value": 2000
            },
            "date": "2023-01-14T17:32:28Z",
            "paymentMethodFamily": "CreditCard",
            "paymentMethodType": "visa",
            "paymentType": "credited"
          }
        ],
        "purchaseOrderNumber": "123456",
        "status": "Due",
        "subscriptionDisplayName": "Contoso Operations Billing",
        "subscriptionId": "11111111-1111-1111-1111-111111111111"
      },
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices"
    }
  ]
}

定義

名稱	Description
Amount	數量。
AmountDue	截至目前到期的金額。
AmountRefunded	退款金額。
AmountRequested	要求的退款金額。
AzurePrepaymentApplied	套用至費用的 Azure 預付款金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。
BilledAmount	發票計費週期的總費用。
createdByType	建立資源的身分識別類型。
CreditAmount	發票計費期間傳回和取消的總退款。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。
DocumentSource	檔的來源。適用於巴西的 ENF 和世界其他地區的 DRS。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
FailedPayment	付款失敗。
FailedPaymentReason	付款失敗的原因。
FreeAzureCreditApplied	套用至費用的免費 Azure 點數金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。
Invoice	發票。
InvoiceDocument	檔的屬性。
InvoiceDocumentType	檔的型別。
InvoiceListResult	資源清單的容器
InvoiceProperties	發票。
InvoiceStatus	發票的目前狀態。
InvoiceType	發票類型。
Payment	發票付款。
PaymentMethodFamily	付款方式系列。
RebillDetails	發票的重新計費詳細數據。
RefundDetails	退款要求的詳細數據。
RefundReasonCode	退款的原因。
RefundStatus	退款要求的狀態。
SpecialTaxationType	識別用於發票的稅務計算類型。欄位僅適用於具有特殊稅務計算邏輯的發票。
SubTotal	應繳稅前金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。
systemData	與建立和上次修改資源相關的元數據。
TaxAmount	計費期間所收取的稅金金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。
TotalAmount	產生發票時到期的金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。

Amount

數量。

名稱	類型	Description
currency	string	金額值的貨幣。
value	number	數量值。例如，如果貨幣是美元，則值為 600$600.00。

AmountDue

截至目前到期的金額。

名稱	類型	Description
currency	string	金額值的貨幣。
value	number	數量值。例如，如果貨幣是美元，則值為 600$600.00。

AmountRefunded

退款金額。

名稱	類型	Description
currency	string	金額值的貨幣。
value	number	數量值。例如，如果貨幣是美元，則值為 600$600.00。

AmountRequested

要求的退款金額。

名稱	類型	Description
currency	string	金額值的貨幣。
value	number	數量值。例如，如果貨幣是美元，則值為 600$600.00。

AzurePrepaymentApplied

套用至費用的 Azure 預付款金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。

名稱	類型	Description
currency	string	金額值的貨幣。
value	number	數量值。例如，如果貨幣是美元，則值為 600$600.00。

BilledAmount

發票計費週期的總費用。

名稱	類型	Description
currency	string	金額值的貨幣。
value	number	數量值。例如，如果貨幣是美元，則值為 600$600.00。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreditAmount

發票計費期間傳回和取消的總退款。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。

名稱	類型	Description
currency	string	金額值的貨幣。
value	number	數量值。例如，如果貨幣是美元，則值為 600$600.00。

DocumentSource

檔的來源。適用於巴西的 ENF 和世界其他地區的 DRS。

名稱	類型	Description
DRS	string
ENF	string
Other	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

FailedPayment

付款失敗。

名稱	類型	Description
date	string	嘗試付款的日期。
failedPaymentReason	FailedPaymentReason	付款失敗的原因。

FailedPaymentReason

付款失敗的原因。

名稱	類型	Description
BankDeclined	string
CardExpired	string
IncorrectCardDetails	string
Other	string

FreeAzureCreditApplied

套用至費用的免費 Azure 點數金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。

名稱	類型	Description
currency	string	金額值的貨幣。
value	number	數量值。例如，如果貨幣是美元，則值為 600$600.00。

Invoice

發票。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties	InvoiceProperties	發票。
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
tags	object	與資源相關聯的元數據字典。並非所有資源類型都會填入。支援的索引鍵/值長度上限為 256 個字元。索引鍵/值不應空白值或 Null。索引鍵不能包含 <> % & \ ？ /
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

InvoiceDocument

檔的屬性。

名稱	類型	Description
documentNumbers	string[]	發票文件的文件編號。
externalUrl	string	如果來源是外部Microsoft.Billing，則為下載發票檔的 URL。
kind	InvoiceDocumentType	檔的型別。
name	string	可唯一識別發票文件的標識碼。此標識碼可能是發票 PDF、點數附註或稅務收據的標識碼。
source	DocumentSource	檔的來源。適用於巴西的 ENF 和世界其他地區的 DRS。
url	string	如果來源是內部Microsoft.Billing，則下載發票檔的 URL。

InvoiceDocumentType

檔的型別。

名稱	類型	Description
CreditNote	string
Invoice	string
Other	string
Summary	string
TaxReceipt	string
Transactions	string
VoidNote	string

InvoiceListResult

資源清單的容器

名稱	類型	Description
nextLink	string	結果下一頁的連結（url）。
value	Invoice[]	資源清單。

InvoiceProperties

發票。

名稱	類型	Description
amountDue	AmountDue	截至目前到期的金額。
azurePrepaymentApplied	AzurePrepaymentApplied	套用至費用的 Azure 預付款金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。
billedAmount	BilledAmount	發票計費週期的總費用。
billedDocumentId	string	使用中發票的標識碼，原本在此發票無效后計費。此欄位僅適用於 void 發票。
billingProfileDisplayName	string	產生發票之帳單配置檔的名稱。
billingProfileId	string	產生發票之帳單配置檔的標識碼。
creditAmount	CreditAmount	發票計費期間傳回和取消的總退款。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。
creditForDocumentId	string	發票的標識碼已失效，因此發出此點數附注。此欄位僅適用於信用額度。
documentType	InvoiceDocumentType	檔的型別。
documents	InvoiceDocument[]	可供下載和檢視的文件清單，例如發票、信用單或稅務收據。
dueDate	string	發票的到期日。
failedPayments	FailedPayment[]	失敗付款的清單。
freeAzureCreditApplied	FreeAzureCreditApplied	套用至費用的免費 Azure 點數金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。
invoiceDate	string	產生發票的日期。
invoicePeriodEndDate	string	產生發票之計費週期的結束日期。日期的格式為MM-DD-YYYY。
invoicePeriodStartDate	string	產生發票之計費週期的開始日期。日期的格式為MM-DD-YYYY。
invoiceType	InvoiceType	發票類型。
isMonthlyInvoice	boolean	指定發票是否在每月發票週期中產生。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。
payments	Payment[]	付款清單。
purchaseOrderNumber	string	發票的選擇性採購單號碼。
rebillDetails	RebillDetails	重新計費發票的詳細數據。
refundDetails	RefundDetails	退款要求的詳細數據。
specialTaxationType	SpecialTaxationType	識別用於發票的稅務計算類型。欄位僅適用於具有特殊稅務計算邏輯的發票。
status	InvoiceStatus	發票的目前狀態。
subTotal	SubTotal	應繳稅前金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。
subscriptionDisplayName	string	產生發票的計費訂用帳戶名稱。
subscriptionId	string	產生發票之訂用帳戶的標識碼。
taxAmount	TaxAmount	計費期間所收取的稅金金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。
totalAmount	TotalAmount	產生發票時到期的金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。

InvoiceStatus

發票的目前狀態。

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

InvoiceType

發票類型。

名稱	類型	Description
AzureMarketplace	string
AzureServices	string
AzureSupport	string
Other	string

Payment

發票付款。

名稱	類型	Description
amount	Amount	付費金額。
date	string	付款的日期。
paymentMethodFamily	PaymentMethodFamily	付款方式系列。
paymentMethodId	string	可唯一識別發票所用付款方式的標識碼。
paymentMethodType	string	付款方式的類型。
paymentType	string	付款的類型。

PaymentMethodFamily

付款方式系列。

名稱	類型	Description
CheckWire	string
CreditCard	string
Credits	string
DirectDebit	string
EWallet	string
None	string
Other	string
TaskOrder	string

RebillDetails

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

名稱	類型	Description
creditNoteDocumentId	string	點數附註的標識碼。
invoiceDocumentId	string	發票的標識碼。
rebillDetails	RebillDetails	發票的重新計費詳細數據。

RefundDetails

退款要求的詳細數據。

名稱	類型	Description
amountRefunded	AmountRefunded	退款金額。
amountRequested	AmountRequested	要求的退款金額。
approvedOn	string	核准退款的日期。
completedOn	string	完成退款的日期。
rebillInvoiceId	string	退款之重新計費發票的發票標識碼。
refundOperationId	string	退款作業的標識碼。
refundReason	RefundReasonCode	退款的原因。
refundStatus	RefundStatus	退款要求的狀態。
requestedOn	string	要求退款的日期。
transactionCount	integer	退款的交易數目。

RefundReasonCode

退款的原因。

名稱	類型	Description
AccidentalConversion	string
AccidentalPurchase	string
ForgotToCancel	string
Other	string
UnclearDocumentation	string
UnclearPricing	string

RefundStatus

退款要求的狀態。

名稱	類型	Description
Approved	string
Cancelled	string
Completed	string
Declined	string
Expired	string
Other	string
Pending	string

SpecialTaxationType

識別用於發票的稅務計算類型。欄位僅適用於具有特殊稅務計算邏輯的發票。

名稱	類型	Description
InvoiceLevel	string
SubtotalLevel	string

SubTotal

應繳稅前金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。

名稱	類型	Description
currency	string	金額值的貨幣。
value	number	數量值。例如，如果貨幣是美元，則值為 600$600.00。

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

TaxAmount

計費期間所收取的稅金金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。

名稱	類型	Description
currency	string	金額值的貨幣。
value	number	數量值。例如，如果貨幣是美元，則值為 600$600.00。

TotalAmount

產生發票時到期的金額。此欄位適用於合約類型Microsoft客戶合約的計費帳戶。

名稱	類型	Description
currency	string	金額值的貨幣。
value	number	數量值。例如，如果貨幣是美元，則值為 600$600.00。

共用方式為