Invoices - List By Billing Subscription

Usługa:

Billing

Wersja interfejsu API:

2024-04-01

Wyświetla listę faktur dla subskrypcji.

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

Z parametrami opcjonalnymi:

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}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator, który jednoznacznie identyfikuje subskrypcję rozliczeniową. Wzorzec wyrażenia regularnego: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	Wersja interfejsu API, która ma być używana z żądaniem klienta. Bieżąca wersja to 2024-04-01.
count	query		boolean	Opcja liczby zapytań umożliwia klientom zażądanie liczby pasujących zasobów uwzględnionych w zasobach w odpowiedzi.
filter	query		string	Opcja zapytania filtru umożliwia klientom filtrowanie kolekcji zasobów, które są adresowane przez adres URL żądania.
orderBy	query		string	Opcja zapytania orderby umożliwia klientom żądanie zasobów w określonej kolejności.
periodEndDate	query		string date	Data zakończenia okresu rozliczeniowego, dla którego jest generowana faktura. Data jest w formacie MM-DD-YYYY.
periodStartDate	query		string date	Data rozpoczęcia okresu rozliczeniowego, dla którego jest generowana faktura. Data jest w formacie MM-DD-YYYY.
search	query		string	Opcja kwerendy wyszukiwania umożliwia klientom żądanie elementów w kolekcji zgodnej z wyrażeniem wyszukiwania w tekście. wyszukiwanie jest obsługiwane tylko w przypadku pól ciągów.
skip	query		integer int64	Opcja pomiń zapytanie żąda liczby elementów w kolekcji zapytań, które mają zostać pominięte i nie zostaną uwzględnione w wyniku.
top	query		integer int64	Opcja zapytania najwyższego poziomu żąda liczby elementów w kolekcji zapytań, które mają zostać uwzględnione w wyniku. Maksymalna obsługiwana wartość dla góry to 50.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	InvoiceListResult	Lista faktur.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

InvoicesListByBillingSubscription

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
Amount	Kwota.
AmountDue	Kwota należna od teraz.
AmountRefunded	Zwrócona kwota.
AmountRequested	Żądana kwota zwrotu pieniędzy.
AzurePrepaymentApplied	Kwota przedpłaty za platformę Azure zastosowana do opłat. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.
BilledAmount	Łączne opłaty za okres rozliczeniowy faktury.
createdByType	Typ tożsamości, która utworzyła zasób.
CreditAmount	Łą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.
DocumentSource	Źródło dokumentu. ENF dla Brazylii i DRS dla reszty świata.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
FailedPayment	Płatność nie powiodła się.
FailedPaymentReason	Przyczyna niepowodzenia płatności.
FreeAzureCreditApplied	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.
Invoice	Faktura.
InvoiceDocument	Właściwości dokumentu.
InvoiceDocumentType	Typ dokumentu.
InvoiceListResult	Kontener dla listy zasobów
InvoiceProperties	Faktura.
InvoiceStatus	Bieżący stan faktury.
InvoiceType	Typ faktury.
Payment	Płatność na podstawie faktury.
PaymentMethodFamily	Rodzina formy płatności.
RebillDetails	Szczegóły faktury.
RefundDetails	Szczegóły żądania zwrotu pieniędzy.
RefundReasonCode	Przyczyna zwrotu pieniędzy.
RefundStatus	Stan żądania zwrotu pieniędzy.
SpecialTaxationType	Określa typ obliczenia podatkowego używanego dla faktury. Pole ma zastosowanie tylko do faktur z specjalną logiką obliczania podatku.
SubTotal	Należna kwota przed opodatkowaniem. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
TaxAmount	Kwota podatku naliczona za okres rozliczeniowy. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.
TotalAmount	Kwota należna po wygenerowaniu faktury. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.

Amount

Kwota.

Nazwa	Typ	Opis
currency	string	Waluta dla wartości kwoty.
value	number	Wartość kwoty. Jeśli na przykład waluta to USD, wartość 600 USD będzie wynosić 600,00 USD.

AmountDue

Kwota należna od teraz.

Nazwa	Typ	Opis
currency	string	Waluta dla wartości kwoty.
value	number	Wartość kwoty. Jeśli na przykład waluta to USD, wartość 600 USD będzie wynosić 600,00 USD.

AmountRefunded

Zwrócona kwota.

Nazwa	Typ	Opis
currency	string	Waluta dla wartości kwoty.
value	number	Wartość kwoty. Jeśli na przykład waluta to USD, wartość 600 USD będzie wynosić 600,00 USD.

AmountRequested

Żądana kwota zwrotu pieniędzy.

Nazwa	Typ	Opis
currency	string	Waluta dla wartości kwoty.
value	number	Wartość kwoty. Jeśli na przykład waluta to USD, wartość 600 USD będzie wynosić 600,00 USD.

AzurePrepaymentApplied

Kwota przedpłaty za platformę Azure zastosowana do opłat. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.

Nazwa	Typ	Opis
currency	string	Waluta dla wartości kwoty.
value	number	Wartość kwoty. Jeśli na przykład waluta to USD, wartość 600 USD będzie wynosić 600,00 USD.

BilledAmount

Łączne opłaty za okres rozliczeniowy faktury.

Nazwa	Typ	Opis
currency	string	Waluta dla wartości kwoty.
value	number	Wartość kwoty. Jeśli na przykład waluta to USD, wartość 600 USD będzie wynosić 600,00 USD.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

CreditAmount

Łą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.

Nazwa	Typ	Opis
currency	string	Waluta dla wartości kwoty.
value	number	Wartość kwoty. Jeśli na przykład waluta to USD, wartość 600 USD będzie wynosić 600,00 USD.

DocumentSource

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

Nazwa	Typ	Opis
DRS	string
ENF	string
Other	string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

FailedPayment

Płatność nie powiodła się.

Nazwa	Typ	Opis
date	string	Data próby płatności.
failedPaymentReason	FailedPaymentReason	Przyczyna niepowodzenia płatności.

FailedPaymentReason

Przyczyna niepowodzenia płatności.

Nazwa	Typ	Opis
BankDeclined	string
CardExpired	string
IncorrectCardDetails	string
Other	string

FreeAzureCreditApplied

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.

Nazwa	Typ	Opis
currency	string	Waluta dla wartości kwoty.
value	number	Wartość kwoty. Jeśli na przykład waluta to USD, wartość 600 USD będzie wynosić 600,00 USD.

Invoice

Faktura.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties	InvoiceProperties	Faktura.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	object	Słownik metadanych skojarzonych z zasobem. Nie można go wypełnić dla wszystkich typów zasobów. Maksymalna długość klucza/wartości obsługiwana przez 256 znaków. Klucze/wartość nie powinny być puste ani mieć wartości null. Klucze nie mogą zawierać <> % & \ ? /
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

InvoiceDocument

Właściwości dokumentu.

Nazwa	Typ	Opis
documentNumbers	string[]	Numery dokumentów dla dokumentu faktury.
externalUrl	string	Adres URL do pobrania dokumentu faktury, jeśli źródło jest zewnętrzne dla microsoft.Billing.
kind	InvoiceDocumentType	Typ dokumentu.
name	string	Identyfikator, który jednoznacznie identyfikuje dokument faktury. Ten identyfikator może być identyfikatorem pliku PDF faktury, noty kredytowej lub paragonu podatkowego.
source	DocumentSource	Źródło dokumentu. ENF dla Brazylii i DRS dla reszty świata.
url	string	Adres URL do pobrania dokumentu faktury, jeśli źródło jest wewnętrzne w witrynie Microsoft.Billing.

InvoiceDocumentType

Typ dokumentu.

Nazwa	Typ	Opis
CreditNote	string
Invoice	string
Other	string
Summary	string
TaxReceipt	string
Transactions	string
VoidNote	string

InvoiceListResult

Kontener dla listy zasobów

Nazwa	Typ	Opis
nextLink	string	Link (adres URL) do następnej strony wyników.
value	Invoice[]	Lista zasobów.

InvoiceProperties

Faktura.

Nazwa	Typ	Opis
amountDue	AmountDue	Kwota należna od teraz.
azurePrepaymentApplied	AzurePrepaymentApplied	Kwota przedpłaty za platformę Azure zastosowana do opłat. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.
billedAmount	BilledAmount	Łączne opłaty za okres rozliczeniowy faktury.
billedDocumentId	string	Identyfikator aktywnej faktury, która jest pierwotnie rozliczana po unieważnieniu tej faktury. To pole ma zastosowanie tylko do faktur unieważnianych.
billingProfileDisplayName	string	Nazwa profilu rozliczeniowego, dla którego jest generowana faktura.
billingProfileId	string	Identyfikator profilu rozliczeniowego, dla którego jest generowana faktura.
creditAmount	CreditAmount	Łą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.
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.
documentType	InvoiceDocumentType	Typ dokumentu.
documents	InvoiceDocument[]	Lista dokumentów dostępnych do pobrania i wyświetlania, takich jak faktura, notatka kredytowa lub paragon podatkowy.
dueDate	string	Data ukończenia faktury.
failedPayments	FailedPayment[]	Lista nieudanych płatności.
freeAzureCreditApplied	FreeAzureCreditApplied	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.
invoiceDate	string	Data wygenerowania faktury.
invoicePeriodEndDate	string	Data zakończenia okresu rozliczeniowego, dla którego jest generowana faktura. Data jest w formacie MM-DD-YYYY.
invoicePeriodStartDate	string	Data rozpoczęcia okresu rozliczeniowego, dla którego jest generowana faktura. Data jest w formacie MM-DD-YYYY.
invoiceType	InvoiceType	Typ faktury.
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.
payments	Payment[]	Lista płatności.
purchaseOrderNumber	string	Opcjonalny numer zamówienia zakupu dla faktury.
rebillDetails	RebillDetails	Szczegóły ponownego wysyłania faktury.
refundDetails	RefundDetails	Szczegóły żądania zwrotu pieniędzy.
specialTaxationType	SpecialTaxationType	Określa typ obliczenia podatkowego używanego dla faktury. Pole ma zastosowanie tylko do faktur z specjalną logiką obliczania podatku.
status	InvoiceStatus	Bieżący stan faktury.
subTotal	SubTotal	Należna kwota przed opodatkowaniem. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.
subscriptionDisplayName	string	Nazwa subskrypcji rozliczeniowej, dla której jest generowana faktura.
subscriptionId	string	Identyfikator subskrypcji, dla której jest generowana faktura.
taxAmount	TaxAmount	Kwota podatku naliczona za okres rozliczeniowy. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.
totalAmount	TotalAmount	Kwota należna po wygenerowaniu faktury. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.

InvoiceStatus

Bieżący stan faktury.

Nazwa	Typ	Opis
Due	string
Locked	string
Other	string
OverDue	string
Paid	string
Void	string

InvoiceType

Typ faktury.

Nazwa	Typ	Opis
AzureMarketplace	string
AzureServices	string
AzureSupport	string
Other	string

Payment

Płatność na podstawie faktury.

Nazwa	Typ	Opis
amount	Amount	Zapłacona kwota.
date	string	Data dokonania płatności.
paymentMethodFamily	PaymentMethodFamily	Rodzina formy płatności.
paymentMethodId	string	Identyfikator, który jednoznacznie identyfikuje formę płatności używaną dla faktury.
paymentMethodType	string	Typ formy płatności.
paymentType	string	Typ płatności.

PaymentMethodFamily

Rodzina formy płatności.

Nazwa	Typ	Opis
CheckWire	string
CreditCard	string
Credits	string
DirectDebit	string
EWallet	string
None	string
Other	string
TaskOrder	string

RebillDetails

Szczegóły faktury.

Nazwa	Typ	Opis
creditNoteDocumentId	string	Identyfikator noty kredytowej.
invoiceDocumentId	string	Identyfikator faktury.
rebillDetails	RebillDetails	Szczegóły faktury.

RefundDetails

Szczegóły żądania zwrotu pieniędzy.

Nazwa	Typ	Opis
amountRefunded	AmountRefunded	Zwrócona kwota.
amountRequested	AmountRequested	Żądana kwota zwrotu pieniędzy.
approvedOn	string	Data zatwierdzenia zwrotu pieniędzy.
completedOn	string	Data ukończenia zwrotu pieniędzy.
rebillInvoiceId	string	Identyfikator faktury na fakturze zwrotnej dla zwrotu kosztów.
refundOperationId	string	Identyfikator operacji zwrotu.
refundReason	RefundReasonCode	Przyczyna zwrotu pieniędzy.
refundStatus	RefundStatus	Stan żądania zwrotu pieniędzy.
requestedOn	string	Data żądania zwrotu pieniędzy.
transactionCount	integer	Liczba zwróconych transakcji.

RefundReasonCode

Przyczyna zwrotu pieniędzy.

Nazwa	Typ	Opis
AccidentalConversion	string
AccidentalPurchase	string
ForgotToCancel	string
Other	string
UnclearDocumentation	string
UnclearPricing	string

RefundStatus

Stan żądania zwrotu pieniędzy.

Nazwa	Typ	Opis
Approved	string
Cancelled	string
Completed	string
Declined	string
Expired	string
Other	string
Pending	string

SpecialTaxationType

Określa typ obliczenia podatkowego używanego dla faktury. Pole ma zastosowanie tylko do faktur z specjalną logiką obliczania podatku.

Nazwa	Typ	Opis
InvoiceLevel	string
SubtotalLevel	string

SubTotal

Należna kwota przed opodatkowaniem. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.

Nazwa	Typ	Opis
currency	string	Waluta dla wartości kwoty.
value	number	Wartość kwoty. Jeśli na przykład waluta to USD, wartość 600 USD będzie wynosić 600,00 USD.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

TaxAmount

Kwota podatku naliczona za okres rozliczeniowy. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.

Nazwa	Typ	Opis
currency	string	Waluta dla wartości kwoty.
value	number	Wartość kwoty. Jeśli na przykład waluta to USD, wartość 600 USD będzie wynosić 600,00 USD.

TotalAmount

Kwota należna po wygenerowaniu faktury. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft.

Nazwa	Typ	Opis
currency	string	Waluta dla wartości kwoty.
value	number	Wartość kwoty. Jeśli na przykład waluta to USD, wartość 600 USD będzie wynosić 600,00 USD.