Invoices - Get By Billing Account

Tjänst:

Billing

API-version:

2024-04-01

Hämtar en faktura efter faktureringskontonamn och ID. Åtgärden stöds för faktureringskonton med avtalstypen Microsoft-partneravtal eller Microsoft-kundavtal.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
billingAccountName	path	True	string	Det ID som unikt identifierar ett faktureringskonto. Reguljärt uttrycksmönster: ^([0-9]+|([Pp][Cc][Nn]\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$
invoiceName	path	True	string	Det ID som unikt identifierar en faktura. Reguljärt uttrycksmönster: ^(H[0-9]-[A-Z0-9]+)$|^(?:([GHT]|HT){1}[A-Z0-9]{9})$|^(?:[D]{1}[A-Z0-9]{9})$|^(?:E{1}[B-Z0-9]{1}[A-Z0-9]{8})$|^(?:EA[A-Z0-9]{8})$
api-version	query	True	string	Den version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2024-04-01.

Svar

Name	Typ	Description
200 OK	Invoice	Listan över fakturor.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Exempel

InvoicesGetByBillingAccount

Exempelbegäran

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789?api-version=2024-04-01

Exempelsvar

Statuskod:

200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789",
  "name": "G123456789",
  "properties": {
    "amountDue": {
      "currency": "USD",
      "value": 8.53
    },
    "azurePrepaymentApplied": {
      "currency": "USD",
      "value": 25.46
    },
    "billedAmount": {
      "currency": "USD",
      "value": 33.99
    },
    "billingProfileDisplayName": "Contoso Operations Billing",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx",
    "creditAmount": {
      "currency": "USD",
      "value": 0
    },
    "documents": [
      {
        "kind": "Invoice",
        "name": "12345678"
      },
      {
        "kind": "TaxReceipt",
        "name": "22345678"
      }
    ],
    "documentType": "Invoice",
    "dueDate": "2023-02-16T17:32:28Z",
    "freeAzureCreditApplied": {
      "currency": "USD",
      "value": 0
    },
    "invoiceDate": "2023-02-01T17:32:28Z",
    "invoicePeriodEndDate": "2023-02-15T17:32:28Z",
    "invoicePeriodStartDate": "2023-02-01T17:32:28Z",
    "isMonthlyInvoice": false,
    "purchaseOrderNumber": "123456",
    "rebillDetails": {
      "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002",
      "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2",
      "rebillDetails": {
        "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001",
        "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote"
      }
    },
    "status": "Due",
    "specialTaxationType": "SubtotalLevel",
    "subTotal": {
      "currency": "USD",
      "value": 33.99
    },
    "taxAmount": {
      "currency": "USD",
      "value": 1
    },
    "totalAmount": {
      "currency": "USD",
      "value": 7.53
    }
  },
  "type": "Microsoft.Billing/billingAccounts/invoices"
}

Definitioner

Name	Description
Amount	Beloppet.
AmountDue	Det belopp som förfaller från och med nu.
AmountRefunded	Det återbetalade beloppet.
AmountRequested	Det begärda återbetalningsbeloppet.
AzurePrepaymentApplied	Beloppet för Azure-förskottsbetalning som tillämpas på avgifterna. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.
BilledAmount	De totala avgifterna för fakturafaktureringsperioden.
createdByType	Den typ av identitet som skapade resursen.
CreditAmount	Den totala återbetalningen för returer och annulleringar under fakturafaktureringsperioden. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.
DocumentSource	Källan till dokumentet. ENF för Brasilien och DRS för resten av världen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
FailedPayment	En misslyckad betalning.
FailedPaymentReason	Anledningen till att betalningen misslyckades.
FreeAzureCreditApplied	Mängden kostnadsfria Azure-krediter som tillämpas på avgifterna. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.
Invoice	En faktura.
InvoiceDocument	Egenskaperna för ett dokument.
InvoiceDocumentType	Dokumentets typ.
InvoiceProperties	En faktura.
InvoiceStatus	Fakturans aktuella status.
InvoiceType	Fakturatyp.
Payment	En fakturabetalning.
PaymentMethodFamily	Betalningsmetodens familj.
RebillDetails	Fakturans omfaktureringsinformation.
RefundDetails	Information om en återbetalningsbegäran.
RefundReasonCode	Orsaken till återbetalningen.
RefundStatus	Status för begäran om återbetalning.
SpecialTaxationType	Identifierar vilken typ av skatteberäkning som används för fakturan. Fältet gäller endast för fakturor med särskild logik för skatteberäkning.
SubTotal	Det förfallna beloppet före skatt. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.
systemData	Metadata som rör skapande och senaste ändring av resursen.
TaxAmount	Det skattebelopp som debiteras för faktureringsperioden. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.
TotalAmount	Det belopp som skulle betalas när fakturan genererades. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.

Amount

Beloppet.

Name	Typ	Description
currency	string	Valutan för beloppsvärdet.
value	number	Beloppsvärdet. Om valutan till exempel är USD skulle värdet 600 vara 600,00 USD.

AmountDue

Det belopp som förfaller från och med nu.

Name	Typ	Description
currency	string	Valutan för beloppsvärdet.
value	number	Beloppsvärdet. Om valutan till exempel är USD skulle värdet 600 vara 600,00 USD.

AmountRefunded

Det återbetalade beloppet.

Name	Typ	Description
currency	string	Valutan för beloppsvärdet.
value	number	Beloppsvärdet. Om valutan till exempel är USD skulle värdet 600 vara 600,00 USD.

AmountRequested

Det begärda återbetalningsbeloppet.

Name	Typ	Description
currency	string	Valutan för beloppsvärdet.
value	number	Beloppsvärdet. Om valutan till exempel är USD skulle värdet 600 vara 600,00 USD.

AzurePrepaymentApplied

Beloppet för Azure-förskottsbetalning som tillämpas på avgifterna. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.

Name	Typ	Description
currency	string	Valutan för beloppsvärdet.
value	number	Beloppsvärdet. Om valutan till exempel är USD skulle värdet 600 vara 600,00 USD.

BilledAmount

De totala avgifterna för fakturafaktureringsperioden.

Name	Typ	Description
currency	string	Valutan för beloppsvärdet.
value	number	Beloppsvärdet. Om valutan till exempel är USD skulle värdet 600 vara 600,00 USD.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreditAmount

Den totala återbetalningen för returer och annulleringar under fakturafaktureringsperioden. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.

Name	Typ	Description
currency	string	Valutan för beloppsvärdet.
value	number	Beloppsvärdet. Om valutan till exempel är USD skulle värdet 600 vara 600,00 USD.

DocumentSource

Källan till dokumentet. ENF för Brasilien och DRS för resten av världen.

Name	Typ	Description
DRS	string
ENF	string
Other	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

FailedPayment

En misslyckad betalning.

Name	Typ	Description
date	string	Det datum då betalningen gjordes.
failedPaymentReason	FailedPaymentReason	Anledningen till att betalningen misslyckades.

FailedPaymentReason

Anledningen till att betalningen misslyckades.

Name	Typ	Description
BankDeclined	string
CardExpired	string
IncorrectCardDetails	string
Other	string

FreeAzureCreditApplied

Mängden kostnadsfria Azure-krediter som tillämpas på avgifterna. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.

Name	Typ	Description
currency	string	Valutan för beloppsvärdet.
value	number	Beloppsvärdet. Om valutan till exempel är USD skulle värdet 600 vara 600,00 USD.

Invoice

En faktura.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties	InvoiceProperties	En faktura.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Ordlista med metadata som är associerade med resursen. Den kanske inte fylls i för alla resurstyper. Maximal nyckel/värdelängd som stöds på 256 tecken. Nycklar/värde får inte vara tomt eller null. Nycklar kan inte innehålla <> % & \ ? /
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

InvoiceDocument

Egenskaperna för ett dokument.

Name	Typ	Description
documentNumbers	string[]	Dokumentnumren för fakturadokumentet.
externalUrl	string	URL:en för att ladda ned fakturadokumentet om källan är extern till Microsoft.Billing.
kind	InvoiceDocumentType	Dokumentets typ.
name	string	Det ID som unikt identifierar ett fakturadokument. Det här ID:t kan vara en identifierare för en PDF-faktura, en kreditfaktura eller ett skattekvitto.
source	DocumentSource	Källan till dokumentet. ENF för Brasilien och DRS för resten av världen.
url	string	URL:en för att ladda ned fakturadokumentet om källan är intern för Microsoft.Billing.

InvoiceDocumentType

Dokumentets typ.

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

InvoiceProperties

En faktura.

Name	Typ	Description
amountDue	AmountDue	Det belopp som förfaller från och med nu.
azurePrepaymentApplied	AzurePrepaymentApplied	Beloppet för Azure-förskottsbetalning som tillämpas på avgifterna. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.
billedAmount	BilledAmount	De totala avgifterna för fakturafaktureringsperioden.
billedDocumentId	string	ID:t för den aktiva fakturan som ursprungligen fakturerades efter att den här fakturan ogiltigförklarades. Det här fältet gäller endast för fakturorna.
billingProfileDisplayName	string	Namnet på den faktureringsprofil som fakturan genereras för.
billingProfileId	string	ID för faktureringsprofilen som fakturan genereras för.
creditAmount	CreditAmount	Den totala återbetalningen för returer och annulleringar under fakturafaktureringsperioden. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.
creditForDocumentId	string	ID:t för fakturan som ogiltigförklarades och denna kreditfaktura utfärdades därför. Det här fältet gäller endast för kreditnoterna.
documentType	InvoiceDocumentType	Dokumentets typ.
documents	InvoiceDocument[]	Lista över dokument som kan laddas ned och visas, till exempel faktura, kreditfaktura eller skattekvitto.
dueDate	string	Förfallodatumet för fakturan.
failedPayments	FailedPayment[]	Lista över misslyckade betalningar.
freeAzureCreditApplied	FreeAzureCreditApplied	Mängden kostnadsfria Azure-krediter som tillämpas på avgifterna. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.
invoiceDate	string	Det datum då fakturan genererades.
invoicePeriodEndDate	string	Slutdatumet för faktureringsperioden som fakturan genereras för. Datumet är i MM-DD-YYYY format.
invoicePeriodStartDate	string	Startdatumet för faktureringsperioden som fakturan genereras för. Datumet är i MM-DD-YYYY format.
invoiceType	InvoiceType	Fakturatyp.
isMonthlyInvoice	boolean	Anger om fakturan genereras som en del av månadsfaktureringscykeln eller inte. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.
payments	Payment[]	Lista över betalningar.
purchaseOrderNumber	string	Ett valfritt inköpsordernummer för fakturan.
rebillDetails	RebillDetails	Fakturera om information för en faktura.
refundDetails	RefundDetails	Information om en återbetalningsbegäran.
specialTaxationType	SpecialTaxationType	Identifierar vilken typ av skatteberäkning som används för fakturan. Fältet gäller endast för fakturor med särskild logik för skatteberäkning.
status	InvoiceStatus	Fakturans aktuella status.
subTotal	SubTotal	Det förfallna beloppet före skatt. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.
subscriptionDisplayName	string	Namnet på den faktureringsprenumeration som fakturan genereras för.
subscriptionId	string	ID:t för prenumerationen som fakturan genereras för.
taxAmount	TaxAmount	Det skattebelopp som debiteras för faktureringsperioden. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.
totalAmount	TotalAmount	Det belopp som skulle betalas när fakturan genererades. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.

InvoiceStatus

Fakturans aktuella status.

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

InvoiceType

Fakturatyp.

Name	Typ	Description
AzureMarketplace	string
AzureServices	string
AzureSupport	string
Other	string

Payment

En fakturabetalning.

Name	Typ	Description
amount	Amount	Det betalda beloppet.
date	string	Datumet då betalningen gjordes.
paymentMethodFamily	PaymentMethodFamily	Betalningsmetodens familj.
paymentMethodId	string	Det ID som unikt identifierar betalningsmetoden som används för fakturan.
paymentMethodType	string	Typ av betalningsmetod.
paymentType	string	Typ av betalning.

PaymentMethodFamily

Betalningsmetodens familj.

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

RebillDetails

Fakturans omfaktureringsinformation.

Name	Typ	Description
creditNoteDocumentId	string	Kreditsedelns ID.
invoiceDocumentId	string	Fakturans ID.
rebillDetails	RebillDetails	Fakturans omfaktureringsinformation.

RefundDetails

Information om en återbetalningsbegäran.

Name	Typ	Description
amountRefunded	AmountRefunded	Det återbetalade beloppet.
amountRequested	AmountRequested	Det begärda återbetalningsbeloppet.
approvedOn	string	Datum då återbetalningen godkändes.
completedOn	string	Datum då återbetalningen slutfördes.
rebillInvoiceId	string	Faktura-ID för fakturan för återbetalning.
refundOperationId	string	ID för återbetalningsåtgärden.
refundReason	RefundReasonCode	Orsaken till återbetalningen.
refundStatus	RefundStatus	Status för begäran om återbetalning.
requestedOn	string	Datum då återbetalningen begärdes.
transactionCount	integer	Antalet återbetalade transaktioner.

RefundReasonCode

Orsaken till återbetalningen.

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

RefundStatus

Status för begäran om återbetalning.

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

SpecialTaxationType

Identifierar vilken typ av skatteberäkning som används för fakturan. Fältet gäller endast för fakturor med särskild logik för skatteberäkning.

Name	Typ	Description
InvoiceLevel	string
SubtotalLevel	string

SubTotal

Det förfallna beloppet före skatt. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.

Name	Typ	Description
currency	string	Valutan för beloppsvärdet.
value	number	Beloppsvärdet. Om valutan till exempel är USD skulle värdet 600 vara 600,00 USD.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

TaxAmount

Det skattebelopp som debiteras för faktureringsperioden. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.

Name	Typ	Description
currency	string	Valutan för beloppsvärdet.
value	number	Beloppsvärdet. Om valutan till exempel är USD skulle värdet 600 vara 600,00 USD.

TotalAmount

Det belopp som skulle betalas när fakturan genererades. Det här fältet gäller för faktureringskonton med avtalstypen Microsoft-kundavtal.

Name	Typ	Description
currency	string	Valutan för beloppsvärdet.
value	number	Beloppsvärdet. Om valutan till exempel är USD skulle värdet 600 vara 600,00 USD.