Dela via


Invoices - List By Billing Profile

Visar en lista över fakturor för en faktureringsprofil för ett visst startdatum och slutdatum. Åtgärden stöds för faktureringskonton med avtalstypen Microsoft-partneravtal eller Microsoft-kundavtal.

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

URI-parametrar

Name I Obligatorisk Typ Description
billingAccountName
path True

string

pattern: ^([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})?)$

Det ID som unikt identifierar ett faktureringskonto.

billingProfileName
path True

string

pattern: ^[a-zA-Z\d-_]{1,128}$

Det ID som unikt identifierar en faktureringsprofil.

api-version
query True

string

Den version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2024-04-01.

count
query

boolean

Med alternativet antal frågor kan klienter begära ett antal matchande resurser som ingår i resurserna i svaret.

filter
query

string

Med alternativet filterfråga kan klienter filtrera en samling resurser som adresseras av en begärande-URL.

orderBy
query

string

Med frågealternativet orderby kan klienter begära resurser i en viss ordning.

periodEndDate
query

string (date)

Slutdatumet för faktureringsperioden som fakturan genereras för. Datumet är i MM-DD-YYYY format.

periodStartDate
query

string (date)

Startdatumet för faktureringsperioden som fakturan genereras för. Datumet är i MM-DD-YYYY format.

search
query

string

Med sökfrågealternativet kan klienter begära objekt i en samling som matchar ett fritextsökningsuttryck. sökning stöds endast för strängfält.

skip
query

integer (int64)

Alternativet Hoppa över fråga begär antalet objekt i den efterfrågade samlingen som ska hoppas över och inte inkluderas i resultatet.

top
query

integer (int64)

Det översta frågealternativet begär att antalet objekt i den efterfrågade samlingen inkluderas i resultatet. Det maximala värdet som stöds för top är 50.

Svar

Name Typ Description
200 OK

InvoiceListResult

Listan över fakturor.

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Exempel

InvoicesListByBillingProfile

Exempelbegäran

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoices?periodStartDate=2023-01-01&periodEndDate=2023-06-30&api-version=2024-04-01

Exempelsvar

{
  "value": [
    {
      "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",
        "subTotal": {
          "currency": "USD",
          "value": 33.99
        },
        "taxAmount": {
          "currency": "USD",
          "value": 1
        },
        "totalAmount": {
          "currency": "USD",
          "value": 7.53
        }
      },
      "type": "Microsoft.Billing/billingAccounts/invoices"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321",
      "name": "G987654321",
      "properties": {
        "amountDue": {
          "currency": "USD",
          "value": 0
        },
        "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-01-16T17:32:28Z",
        "freeAzureCreditApplied": {
          "currency": "USD",
          "value": 0
        },
        "invoiceDate": "2023-01-01T17:32:28Z",
        "invoicePeriodEndDate": "2023-01-15T17:32:28Z",
        "invoicePeriodStartDate": "2023-01-01T17:32:28Z",
        "isMonthlyInvoice": false,
        "payments": [
          {
            "amount": {
              "currency": "USD",
              "value": 33.99
            },
            "date": "2023-01-14T17:32:28Z",
            "paymentMethodFamily": "CreditCard",
            "paymentMethodType": "visa",
            "paymentType": "debited"
          }
        ],
        "purchaseOrderNumber": "123455",
        "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": "Paid",
        "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.

InvoiceListResult

En container för en lista över resurser

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.

Värde Description
Application
Key
ManagedIdentity
User

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.

Värde Description
DRS
ENF
Other

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 (date-time)

Det datum då betalningen gjordes.

failedPaymentReason

FailedPaymentReason

Anledningen till att betalningen misslyckades.

FailedPaymentReason

Anledningen till att betalningen misslyckades.

Värde Description
BankDeclined
CardExpired
IncorrectCardDetails
Other

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 (arm-id)

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.

Värde Description
CreditNote
Invoice
Other
Summary
TaxReceipt
Transactions
VoidNote

InvoiceListResult

En container för en lista över resurser

Name Typ Description
nextLink

string

Länken (url) till nästa resultatsida.

value

Invoice[]

Listan över resurser.

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 (date-time)

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 (date-time)

Det datum då fakturan genererades.

invoicePeriodEndDate

string (date-time)

Slutdatumet för faktureringsperioden som fakturan genereras för. Datumet är i MM-DD-YYYY format.

invoicePeriodStartDate

string (date-time)

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.

Värde Description
Due
Locked
Other
OverDue
Paid
Void

InvoiceType

Fakturatyp.

Värde Description
AzureMarketplace
AzureServices
AzureSupport
Other

Payment

En fakturabetalning.

Name Typ Description
amount

Amount

Det betalda beloppet.

date

string (date-time)

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.

Värde Description
CheckWire
CreditCard
Credits
DirectDebit
EWallet
None
Other
TaskOrder

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 (date-time)

Datum då återbetalningen godkändes.

completedOn

string (date-time)

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 (date-time)

Datum då återbetalningen begärdes.

transactionCount

integer (int32)

Antalet återbetalade transaktioner.

RefundReasonCode

Orsaken till återbetalningen.

Värde Description
AccidentalConversion
AccidentalPurchase
ForgotToCancel
Other
UnclearDocumentation
UnclearPricing

RefundStatus

Status för begäran om återbetalning.

Värde Description
Approved
Cancelled
Completed
Declined
Expired
Other
Pending

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.

Värde Description
InvoiceLevel
SubtotalLevel

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 (date-time)

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string (date-time)

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.