Invoices - List By Billing Subscription

Služba:

Billing

Verze rozhraní API:

2024-04-01

Zobrazí seznam faktur za předplatné.

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

S volitelnými parametry:

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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	ID, které jednoznačně identifikuje fakturační předplatné. Vzor regulárního výrazu: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuální verze je 2024-04-01.
count	query		boolean	Možnost dotazování počtu umožňuje klientům požadovat počet odpovídajících prostředků, které jsou součástí prostředků v odpovědi.
filter	query		string	Možnost dotazu filtru umožňuje klientům filtrovat kolekci prostředků adresovaných adresou URL požadavku.
orderBy	query		string	Možnost dotazu orderby umožňuje klientům požadovat prostředky v určitém pořadí.
periodEndDate	query		string date	Koncové datum fakturačního období, pro které se faktura generuje. Datum je ve formátu MM-DD-YYYY.
periodStartDate	query		string date	Počáteční datum fakturačního období, pro které se faktura vygeneruje. Datum je ve formátu MM-DD-YYYY.
search	query		string	Možnost vyhledávacího dotazu umožňuje klientům požadovat položky v kolekci odpovídající výrazu pro vyhledávání volného textu. Vyhledávání je podporováno pouze pro pole řetězců.
skip	query		integer int64	Možnost přeskočit dotaz vyžaduje počet položek v dotazované kolekci, které se mají přeskočit a nejsou zahrnuty do výsledku.
top	query		integer int64	Horní možnost dotazu požaduje, aby se do výsledku zahrnul počet položek v dotazované kolekci. Maximální podporovaná hodnota pro top je 50.

Odpovědi

Name	Typ	Description
200 OK	InvoiceListResult	Seznam faktur.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Příklady

InvoicesListByBillingSubscription

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
Amount	Částka.
AmountDue	Částka splatná odteď.
AmountRefunded	Částka byla vrácena.
AmountRequested	Požadovaná částka refundace.
AzurePrepaymentApplied	Výše zálohy na Azure uplatněná na poplatky. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.
BilledAmount	Celkové poplatky za fakturační období faktury.
createdByType	Typ identity, která prostředek vytvořila.
CreditAmount	Celková refundace za vrácení a zrušení během fakturačního období faktury. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.
DocumentSource	Zdroj dokumentu. ENF pro Brazílie a DRS pro zbytek světa.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
FailedPayment	Neúspěšná platba.
FailedPaymentReason	Důvod, proč platba selhala.
FreeAzureCreditApplied	Množství bezplatných kreditů Azure uplatněných na poplatky. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.
Invoice	Faktura.
InvoiceDocument	Vlastnosti dokumentu
InvoiceDocumentType	Typ dokumentu.
InvoiceListResult	Kontejner pro seznam prostředků
InvoiceProperties	Faktura.
InvoiceStatus	Aktuální stav faktury.
InvoiceType	Typ faktury.
Payment	Platba pomocí faktury.
PaymentMethodFamily	Rodina způsobů platby.
RebillDetails	Podrobnosti o vyúčtování faktury.
RefundDetails	Podrobnosti žádosti o refundaci
RefundReasonCode	Důvod refundace.
RefundStatus	Stav žádosti o refundaci
SpecialTaxationType	Určuje typ výpočtu daně použitého pro fakturu. Pole se vztahuje pouze na faktury se speciální logikou výpočtu daně.
SubTotal	Částka před zdaněním. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
TaxAmount	Částka daně účtovaná za fakturační období. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.
TotalAmount	Částka splatná při vygenerování faktury. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.

Amount

Částka.

Name	Typ	Description
currency	string	Měna pro hodnotu částky.
value	number	Hodnota částky. Pokud je například měna USD, pak by hodnota 600 USD byla 600,00 USD.

AmountDue

Částka splatná odteď.

Name	Typ	Description
currency	string	Měna pro hodnotu částky.
value	number	Hodnota částky. Pokud je například měna USD, pak by hodnota 600 USD byla 600,00 USD.

AmountRefunded

Částka byla vrácena.

Name	Typ	Description
currency	string	Měna pro hodnotu částky.
value	number	Hodnota částky. Pokud je například měna USD, pak by hodnota 600 USD byla 600,00 USD.

AmountRequested

Požadovaná částka refundace.

Name	Typ	Description
currency	string	Měna pro hodnotu částky.
value	number	Hodnota částky. Pokud je například měna USD, pak by hodnota 600 USD byla 600,00 USD.

AzurePrepaymentApplied

Výše zálohy na Azure uplatněná na poplatky. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.

Name	Typ	Description
currency	string	Měna pro hodnotu částky.
value	number	Hodnota částky. Pokud je například měna USD, pak by hodnota 600 USD byla 600,00 USD.

BilledAmount

Celkové poplatky za fakturační období faktury.

Name	Typ	Description
currency	string	Měna pro hodnotu částky.
value	number	Hodnota částky. Pokud je například měna USD, pak by hodnota 600 USD byla 600,00 USD.

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreditAmount

Celková refundace za vrácení a zrušení během fakturačního období faktury. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.

Name	Typ	Description
currency	string	Měna pro hodnotu částky.
value	number	Hodnota částky. Pokud je například měna USD, pak by hodnota 600 USD byla 600,00 USD.

DocumentSource

Zdroj dokumentu. ENF pro Brazílie a DRS pro zbytek světa.

Name	Typ	Description
DRS	string
ENF	string
Other	string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

FailedPayment

Neúspěšná platba.

Name	Typ	Description
date	string	Datum, kdy došlo k pokusu o platbu.
failedPaymentReason	FailedPaymentReason	Důvod, proč platba selhala.

FailedPaymentReason

Důvod, proč platba selhala.

Name	Typ	Description
BankDeclined	string
CardExpired	string
IncorrectCardDetails	string
Other	string

FreeAzureCreditApplied

Množství bezplatných kreditů Azure uplatněných na poplatky. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.

Name	Typ	Description
currency	string	Měna pro hodnotu částky.
value	number	Hodnota částky. Pokud je například měna USD, pak by hodnota 600 USD byla 600,00 USD.

Invoice

Faktura.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties	InvoiceProperties	Faktura.
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
tags	object	Slovník metadat přidružených k prostředku Nemusí být vyplněna pro všechny typy prostředků. Maximální podporovaná délka klíče a hodnoty 256 znaků. Klíče nebo hodnota by neměly být prázdné ani null. Klíče nemohou obsahovat <> % & \ ? /
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

InvoiceDocument

Vlastnosti dokumentu

Name	Typ	Description
documentNumbers	string[]	Čísla dokumentů pro dokument faktury.
externalUrl	string	Adresa URL pro stažení dokumentu faktury, pokud je zdroj externí pro Microsoft.Billing.
kind	InvoiceDocumentType	Typ dokumentu.
name	string	ID, které jednoznačně identifikuje dokument faktury. Toto ID může být identifikátor faktury VE FORMÁTU PDF, dobropisu nebo daňového potvrzení.
source	DocumentSource	Zdroj dokumentu. ENF pro Brazílie a DRS pro zbytek světa.
url	string	Adresa URL pro stažení dokumentu faktury, pokud je zdroj interní pro Microsoft.Billing.

InvoiceDocumentType

Typ dokumentu.

Name	Typ	Description
CreditNote	string
Invoice	string
Other	string
Summary	string
TaxReceipt	string
Transactions	string
VoidNote	string

InvoiceListResult

Kontejner pro seznam prostředků

Name	Typ	Description
nextLink	string	Odkaz (url) na další stránku výsledků.
value	Invoice[]	Seznam prostředků.

InvoiceProperties

Faktura.

Name	Typ	Description
amountDue	AmountDue	Částka splatná odteď.
azurePrepaymentApplied	AzurePrepaymentApplied	Výše zálohy na Azure uplatněná na poplatky. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.
billedAmount	BilledAmount	Celkové poplatky za fakturační období faktury.
billedDocumentId	string	ID aktivní faktury, která se původně fakturuje po zrušení této faktury. Toto pole se vztahuje pouze na faktury void.
billingProfileDisplayName	string	Název fakturačního profilu, pro který se faktura vygeneruje.
billingProfileId	string	ID fakturačního profilu, pro který se faktura vygeneruje.
creditAmount	CreditAmount	Celková refundace za vrácení a zrušení během fakturačního období faktury. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.
creditForDocumentId	string	ID faktury, která se vypnula, a tato dobropis byla vydána jako výsledek. Toto pole platí jenom pro dobropisy.
documentType	InvoiceDocumentType	Typ dokumentu.
documents	InvoiceDocument[]	Seznam dokumentů, které si můžete stáhnout a zobrazit, jako je faktura, dobropis nebo daňový doklad
dueDate	string	Termín splatnosti faktury.
failedPayments	FailedPayment[]	Seznam neúspěšných plateb
freeAzureCreditApplied	FreeAzureCreditApplied	Množství bezplatných kreditů Azure uplatněných na poplatky. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.
invoiceDate	string	Datum vygenerování faktury.
invoicePeriodEndDate	string	Koncové datum fakturačního období, pro které se faktura generuje. Datum je ve formátu MM-DD-YYYY.
invoicePeriodStartDate	string	Počáteční datum fakturačního období, pro které se faktura vygeneruje. Datum je ve formátu MM-DD-YYYY.
invoiceType	InvoiceType	Typ faktury.
isMonthlyInvoice	boolean	Určuje, jestli se faktura generuje jako součást měsíčního fakturačního cyklu nebo ne. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.
payments	Payment[]	Seznam plateb.
purchaseOrderNumber	string	Volitelné číslo nákupní objednávky pro fakturu.
rebillDetails	RebillDetails	Rebill details for an invoice.
refundDetails	RefundDetails	Podrobnosti žádosti o refundaci
specialTaxationType	SpecialTaxationType	Určuje typ výpočtu daně použitého pro fakturu. Pole se vztahuje pouze na faktury se speciální logikou výpočtu daně.
status	InvoiceStatus	Aktuální stav faktury.
subTotal	SubTotal	Částka před zdaněním. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.
subscriptionDisplayName	string	Název fakturačního předplatného, pro které se faktura vygeneruje.
subscriptionId	string	ID předplatného, pro které se faktura vygeneruje.
taxAmount	TaxAmount	Částka daně účtovaná za fakturační období. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.
totalAmount	TotalAmount	Částka splatná při vygenerování faktury. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.

InvoiceStatus

Aktuální stav faktury.

Name	Typ	Description
Due	string
Locked	string
Other	string
OverDue	string
Paid	string
Void	string

InvoiceType

Typ faktury.

Name	Typ	Description
AzureMarketplace	string
AzureServices	string
AzureSupport	string
Other	string

Payment

Platba pomocí faktury.

Name	Typ	Description
amount	Amount	Zaplacená částka.
date	string	Datum provedení platby.
paymentMethodFamily	PaymentMethodFamily	Rodina způsobů platby.
paymentMethodId	string	ID, které jednoznačně identifikuje způsob platby použitý pro fakturu.
paymentMethodType	string	Typ způsobu platby.
paymentType	string	Typ platby.

PaymentMethodFamily

Rodina způsobů platby.

Name	Typ	Description
CheckWire	string
CreditCard	string
Credits	string
DirectDebit	string
EWallet	string
None	string
Other	string
TaskOrder	string

RebillDetails

Podrobnosti o vyúčtování faktury.

Name	Typ	Description
creditNoteDocumentId	string	ID dobropisu.
invoiceDocumentId	string	ID faktury.
rebillDetails	RebillDetails	Podrobnosti o vyúčtování faktury.

RefundDetails

Podrobnosti žádosti o refundaci

Name	Typ	Description
amountRefunded	AmountRefunded	Částka byla vrácena.
amountRequested	AmountRequested	Požadovaná částka refundace.
approvedOn	string	Datum schválení refundace
completedOn	string	Datum dokončení refundace
rebillInvoiceId	string	ID faktury faktury za refundaci
refundOperationId	string	ID operace refundace.
refundReason	RefundReasonCode	Důvod refundace.
refundStatus	RefundStatus	Stav žádosti o refundaci
requestedOn	string	Datum, kdy byla refundace požadována.
transactionCount	integer	Počet vrácených transakcí.

RefundReasonCode

Důvod refundace.

Name	Typ	Description
AccidentalConversion	string
AccidentalPurchase	string
ForgotToCancel	string
Other	string
UnclearDocumentation	string
UnclearPricing	string

RefundStatus

Stav žádosti o refundaci

Name	Typ	Description
Approved	string
Cancelled	string
Completed	string
Declined	string
Expired	string
Other	string
Pending	string

SpecialTaxationType

Určuje typ výpočtu daně použitého pro fakturu. Pole se vztahuje pouze na faktury se speciální logikou výpočtu daně.

Name	Typ	Description
InvoiceLevel	string
SubtotalLevel	string

SubTotal

Částka před zdaněním. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.

Name	Typ	Description
currency	string	Měna pro hodnotu částky.
value	number	Hodnota částky. Pokud je například měna USD, pak by hodnota 600 USD byla 600,00 USD.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

TaxAmount

Částka daně účtovaná za fakturační období. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.

Name	Typ	Description
currency	string	Měna pro hodnotu částky.
value	number	Hodnota částky. Pokud je například měna USD, pak by hodnota 600 USD byla 600,00 USD.

TotalAmount

Částka splatná při vygenerování faktury. Toto pole se vztahuje na fakturační účty s typem Smlouvy se zákazníkem Microsoftu.

Name	Typ	Description
currency	string	Měna pro hodnotu částky.
value	number	Hodnota částky. Pokud je například měna USD, pak by hodnota 600 USD byla 600,00 USD.