Invoices - Get By Id
Pobiera fakturę według identyfikatora. Ta operacja jest obsługiwana w przypadku kont rozliczeniowych z typem umowy Microsoft Partner Agreement lub Umowa z Klientem Microsoft.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/invoices/{invoiceName}?api-version=2020-05-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
invoice
|
path | True |
string |
Identyfikator, który jednoznacznie identyfikuje fakturę. |
api-version
|
query | True |
string |
Wersja interfejsu API, która ma być używana z żądaniem klienta. Bieżąca wersja to 2020-05-01. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK. Żądanie zakończyło się pomyślnie. |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
Invoice
Przykładowe żądanie
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/invoices/{invoiceName}?api-version=2020-05-01
Przykładowa odpowiedź
{
"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"
}
]
}
}
Definicje
Nazwa | Opis |
---|---|
Amount |
Kwota. |
Document |
Właściwości dokumentu. |
Document |
Źródło dokumentu. ENF dla Brazylii i DRS dla reszty świata. |
Document |
Typ dokumentu. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie. |
Error |
|
Invoice |
Faktura. |
Invoice |
Typ dokumentu. |
Invoice |
Bieżący stan faktury. |
Invoice |
Typ faktury. |
Payment |
Rodzina formy płatności. |
Payment |
Właściwości płatności. |
Rebill |
Szczegóły ponownego wysyłania faktury. |
Amount
Kwota.
Nazwa | Typ | Opis |
---|---|---|
currency |
string |
Waluta dla wartości kwoty. |
value |
number |
Wartość kwoty. |
Document
Właściwości dokumentu.
Nazwa | Typ | Opis |
---|---|---|
kind |
Typ dokumentu. |
|
source |
Źródło dokumentu. ENF dla Brazylii i DRS dla reszty świata. |
|
url |
string |
Adres URL dokumentu. |
DocumentSource
Źródło dokumentu. ENF dla Brazylii i DRS dla reszty świata.
Nazwa | Typ | Opis |
---|---|---|
DRS |
string |
|
ENF |
string |
DocumentType
Typ dokumentu.
Nazwa | Typ | Opis |
---|---|---|
CreditNote |
string |
|
Invoice |
string |
|
TaxReceipt |
string |
|
VoidNote |
string |
ErrorDetails
Szczegóły błędu.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
details |
Szczegóły podrzędne błędu. |
|
message |
string |
Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się. |
target |
string |
Element docelowy określonego błędu. |
ErrorResponse
Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.
Nazwa | Typ | Opis |
---|---|---|
error |
Szczegóły błędu. |
ErrorSubDetails
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
message |
string |
Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się. |
target |
string |
Element docelowy określonego błędu. |
Invoice
Faktura.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu. |
name |
string |
Nazwa zasobu. |
properties.amountDue |
Kwota należna od teraz. |
|
properties.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. |
|
properties.billedAmount |
Łączne opłaty za okres rozliczeniowy faktury. |
|
properties.billedDocumentId |
string |
Identyfikator aktywnej faktury, która jest pierwotnie rozliczana po unieważnieniu faktury. To pole ma zastosowanie tylko do faktur unieważnianych. |
properties.billingProfileDisplayName |
string |
Nazwa profilu rozliczeniowego, dla którego jest generowana faktura. |
properties.billingProfileId |
string |
Identyfikator profilu rozliczeniowego, dla którego jest generowana faktura. |
properties.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. |
|
properties.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. |
properties.documentType |
Typ dokumentu. |
|
properties.documents |
Document[] |
Lista dokumentów dostępnych do pobrania, takich jak faktura i paragon podatkowy. |
properties.dueDate |
string |
Data ukończenia faktury. |
properties.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. |
|
properties.invoiceDate |
string |
Data wygenerowania faktury. |
properties.invoicePeriodEndDate |
string |
Data zakończenia okresu rozliczeniowego, dla którego jest generowana faktura. |
properties.invoicePeriodStartDate |
string |
Data rozpoczęcia okresu rozliczeniowego, dla którego jest generowana faktura. |
properties.invoiceType |
Typ faktury. |
|
properties.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. |
properties.payments |
Lista płatności. |
|
properties.purchaseOrderNumber |
string |
Opcjonalny numer zamówienia zakupu dla faktury. |
properties.rebillDetails |
<string,
Rebill |
Szczegóły ponownego wysyłania faktury. |
properties.status |
Bieżący stan faktury. |
|
properties.subTotal |
Należna kwota przed opodatkowaniem. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft. |
|
properties.subscriptionId |
string |
Identyfikator subskrypcji, dla której jest generowana faktura. |
properties.taxAmount |
Kwota podatku naliczonego w okresie rozliczeniowym. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft. |
|
properties.totalAmount |
Kwota należna podczas generowania faktury. To pole ma zastosowanie do kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft. |
|
type |
string |
Typ zasobu. |
InvoiceDocumentType
Typ dokumentu.
Nazwa | Typ | Opis |
---|---|---|
CreditNote |
string |
|
Invoice |
string |
InvoiceStatus
Bieżący stan faktury.
Nazwa | Typ | Opis |
---|---|---|
Due |
string |
|
OverDue |
string |
|
Paid |
string |
|
Void |
string |
InvoiceType
Typ faktury.
Nazwa | Typ | Opis |
---|---|---|
AzureMarketplace |
string |
|
AzureService |
string |
|
AzureSupport |
string |
PaymentMethodFamily
Rodzina formy płatności.
Nazwa | Typ | Opis |
---|---|---|
CheckWire |
string |
|
CreditCard |
string |
|
Credits |
string |
|
None |
string |
PaymentProperties
Właściwości płatności.
Nazwa | Typ | Opis |
---|---|---|
amount |
Zapłacona kwota. |
|
date |
string |
Data dokonania płatności. |
paymentMethodFamily |
Rodzina formy płatności. |
|
paymentMethodType |
string |
Typ formy płatności. |
paymentType |
string |
Typ płatności. |
RebillDetails
Szczegóły ponownego wysyłania faktury.
Nazwa | Typ | Opis |
---|---|---|
creditNoteDocumentId |
string |
Identyfikator noty kredytowej. |
invoiceDocumentId |
string |
Identyfikator faktury. |
rebillDetails |
<string,
Rebill |
Szczegóły ponownego wysyłania faktury. |