Partager via


Invoices - List By Billing Account

Répertorie les factures d’un compte de facturation pour une date de début et une date de fin donnée. L’opération est prise en charge pour tous les types de comptes de facturation.

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

Paramètres URI

Nom Dans Obligatoire Type 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})?)$

ID qui identifie de façon unique un compte de facturation.

api-version
query True

string

Version de l’API à utiliser avec la demande cliente. La version actuelle est 2024-04-01.

count
query

boolean

L’option de requête count permet aux clients de demander le nombre de ressources correspondantes incluses dans la réponse.

filter
query

string

L’option de requête de filtre permet aux clients de filtrer une collection de ressources qui sont traitées par une URL de requête.

orderBy
query

string

L’option de requête orderby permet aux clients de demander des ressources dans un ordre particulier.

periodEndDate
query

string (date)

Date de fin de la période de facturation pour laquelle la facture est générée. La date est au format MM-DD-YYYY.

periodStartDate
query

string (date)

Date de début de la période de facturation pour laquelle la facture est générée. La date est au format MM-DD-YYYY.

search
query

string

L’option de requête de recherche permet aux clients de demander des éléments dans une collection correspondant à une expression de recherche en texte libre. la recherche n’est prise en charge que pour les champs de chaîne.

skip
query

integer (int64)

L’option ignorer la requête demande le nombre d’éléments de la collection interrogée à ignorer et non inclus dans le résultat.

top
query

integer (int64)

L’option de requête supérieure demande le nombre d’éléments de la collection interrogée à inclure dans le résultat. La valeur maximale prise en charge pour le haut est 50.

Réponses

Nom Type Description
200 OK

InvoiceListResult

Liste des factures.

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Exemples

InvoicesListByBillingAccount

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
Amount

Montant.

AmountDue

Montant dû à l’heure actuelle.

AmountRefunded

Montant remboursé.

AmountRequested

Montant du remboursement demandé.

AzurePrepaymentApplied

Montant du paiement anticipé Azure appliqué aux frais. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

BilledAmount

Frais totaux pour la période de facturation de la facture.

createdByType

Type d’identité qui a créé la ressource.

CreditAmount

Remboursement total des retours et annulations pendant la période de facturation de la facture. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

DocumentSource

Source du document. ENF pour le Brésil et drS pour le reste du monde.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

FailedPayment

Un échec de paiement.

FailedPaymentReason

Raison pour laquelle le paiement a échoué.

FreeAzureCreditApplied

Montant des crédits Azure gratuits appliqués aux frais. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

Invoice

Facture.

InvoiceDocument

Propriétés d’un document.

InvoiceDocumentType

Type du document.

InvoiceListResult

Conteneur pour une liste de ressources

InvoiceProperties

Facture.

InvoiceStatus

État actuel de la facture.

InvoiceType

Type de facture.

Payment

Paiement par facture.

PaymentMethodFamily

Famille de modes de paiement.

RebillDetails

Détails du refacturation d’une facture.

RefundDetails

Détails d’une demande de remboursement.

RefundReasonCode

Motif du remboursement.

RefundStatus

État de la demande de remboursement.

SpecialTaxationType

Identifie le type de calcul fiscal utilisé pour la facture. Le champ s’applique uniquement aux factures avec une logique de calcul fiscal spéciale.

SubTotal

Montant avant impôts dû. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

TaxAmount

Montant de la taxe facturée pour la période de facturation. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

TotalAmount

Montant dû lors de la génération de la facture. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

Amount

Montant.

Nom Type Description
currency

string

Devise de la valeur de montant.

value

number

Valeur du montant. Par exemple, si la devise est USD, une valeur de 600 $ serait de 600,00 $.

AmountDue

Montant dû à l’heure actuelle.

Nom Type Description
currency

string

Devise de la valeur de montant.

value

number

Valeur du montant. Par exemple, si la devise est USD, une valeur de 600 $ serait de 600,00 $.

AmountRefunded

Montant remboursé.

Nom Type Description
currency

string

Devise de la valeur de montant.

value

number

Valeur du montant. Par exemple, si la devise est USD, une valeur de 600 $ serait de 600,00 $.

AmountRequested

Montant du remboursement demandé.

Nom Type Description
currency

string

Devise de la valeur de montant.

value

number

Valeur du montant. Par exemple, si la devise est USD, une valeur de 600 $ serait de 600,00 $.

AzurePrepaymentApplied

Montant du paiement anticipé Azure appliqué aux frais. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

Nom Type Description
currency

string

Devise de la valeur de montant.

value

number

Valeur du montant. Par exemple, si la devise est USD, une valeur de 600 $ serait de 600,00 $.

BilledAmount

Frais totaux pour la période de facturation de la facture.

Nom Type Description
currency

string

Devise de la valeur de montant.

value

number

Valeur du montant. Par exemple, si la devise est USD, une valeur de 600 $ serait de 600,00 $.

createdByType

Type d’identité qui a créé la ressource.

Valeur Description
Application
Key
ManagedIdentity
User

CreditAmount

Remboursement total des retours et annulations pendant la période de facturation de la facture. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

Nom Type Description
currency

string

Devise de la valeur de montant.

value

number

Valeur du montant. Par exemple, si la devise est USD, une valeur de 600 $ serait de 600,00 $.

DocumentSource

Source du document. ENF pour le Brésil et drS pour le reste du monde.

Valeur Description
DRS
ENF
Other

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.

type

string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d’erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

FailedPayment

Un échec de paiement.

Nom Type Description
date

string (date-time)

Date à laquelle le paiement a été tenté.

failedPaymentReason

FailedPaymentReason

Raison pour laquelle le paiement a échoué.

FailedPaymentReason

Raison pour laquelle le paiement a échoué.

Valeur Description
BankDeclined
CardExpired
IncorrectCardDetails
Other

FreeAzureCreditApplied

Montant des crédits Azure gratuits appliqués aux frais. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

Nom Type Description
currency

string

Devise de la valeur de montant.

value

number

Valeur du montant. Par exemple, si la devise est USD, une valeur de 600 $ serait de 600,00 $.

Invoice

Facture.

Nom Type Description
id

string (arm-id)

ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »

name

string

Nom de la ressource

properties

InvoiceProperties

Facture.

systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.

tags

object

Dictionnaire de métadonnées associées à la ressource. Il peut ne pas être rempli pour tous les types de ressources. Longueur maximale de clé/valeur prise en charge de 256 caractères. Les clés/valeur ne doivent pas être vides ni null. Les clés ne peuvent pas contenir <> % & \ ? /

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

InvoiceDocument

Propriétés d’un document.

Nom Type Description
documentNumbers

string[]

Numéros de document pour le document de facture.

externalUrl

string

URL permettant de télécharger le document de facture si la source est externe à Microsoft.Billing.

kind

InvoiceDocumentType

Type du document.

name

string

ID qui identifie de façon unique un document de facture. Cet ID peut être un identificateur d’une facture PDF, d’une note de crédit ou d’un reçu fiscal.

source

DocumentSource

Source du document. ENF pour le Brésil et drS pour le reste du monde.

url

string

URL permettant de télécharger le document de facture si la source est interne à Microsoft.Billing.

InvoiceDocumentType

Type du document.

Valeur Description
CreditNote
Invoice
Other
Summary
TaxReceipt
Transactions
VoidNote

InvoiceListResult

Conteneur pour une liste de ressources

Nom Type Description
nextLink

string

Lien (URL) vers la page suivante des résultats.

value

Invoice[]

Liste des ressources.

InvoiceProperties

Facture.

Nom Type Description
amountDue

AmountDue

Montant dû à l’heure actuelle.

azurePrepaymentApplied

AzurePrepaymentApplied

Montant du paiement anticipé Azure appliqué aux frais. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

billedAmount

BilledAmount

Frais totaux pour la période de facturation de la facture.

billedDocumentId

string

ID de la facture active qui est initialement facturée après l’annulation de cette facture. Ce champ s’applique uniquement aux factures void.

billingProfileDisplayName

string

Nom du profil de facturation pour lequel la facture est générée.

billingProfileId

string

ID du profil de facturation pour lequel la facture est générée.

creditAmount

CreditAmount

Remboursement total des retours et annulations pendant la période de facturation de la facture. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

creditForDocumentId

string

Id de la facture qui a été annulée et cette note de crédit a été émise en conséquence. Ce champ s’applique uniquement aux notes de crédit.

documentType

InvoiceDocumentType

Type du document.

documents

InvoiceDocument[]

Liste des documents disponibles pour télécharger et afficher tels que la facture, la note de crédit ou le reçu fiscal.

dueDate

string (date-time)

Date d’échéance de la facture.

failedPayments

FailedPayment[]

Liste des paiements ayant échoué.

freeAzureCreditApplied

FreeAzureCreditApplied

Montant des crédits Azure gratuits appliqués aux frais. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

invoiceDate

string (date-time)

Date à laquelle la facture a été générée.

invoicePeriodEndDate

string (date-time)

Date de fin de la période de facturation pour laquelle la facture est générée. La date est au format MM-DD-YYYY.

invoicePeriodStartDate

string (date-time)

Date de début de la période de facturation pour laquelle la facture est générée. La date est au format MM-DD-YYYY.

invoiceType

InvoiceType

Type de facture.

isMonthlyInvoice

boolean

Spécifie si la facture est générée dans le cadre du cycle de facturation mensuel ou non. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

payments

Payment[]

Liste des paiements.

purchaseOrderNumber

string

Numéro de bon de commande facultatif pour la facture.

rebillDetails

RebillDetails

Refacturez les détails d’une facture.

refundDetails

RefundDetails

Détails d’une demande de remboursement.

specialTaxationType

SpecialTaxationType

Identifie le type de calcul fiscal utilisé pour la facture. Le champ s’applique uniquement aux factures avec une logique de calcul fiscal spéciale.

status

InvoiceStatus

État actuel de la facture.

subTotal

SubTotal

Montant avant impôts dû. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

subscriptionDisplayName

string

Nom de l’abonnement de facturation pour lequel la facture est générée.

subscriptionId

string

ID de l’abonnement pour lequel la facture est générée.

taxAmount

TaxAmount

Montant de la taxe facturée pour la période de facturation. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

totalAmount

TotalAmount

Montant dû lors de la génération de la facture. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

InvoiceStatus

État actuel de la facture.

Valeur Description
Due
Locked
Other
OverDue
Paid
Void

InvoiceType

Type de facture.

Valeur Description
AzureMarketplace
AzureServices
AzureSupport
Other

Payment

Paiement par facture.

Nom Type Description
amount

Amount

Montant payé.

date

string (date-time)

Date à laquelle le paiement a été effectué.

paymentMethodFamily

PaymentMethodFamily

Famille de modes de paiement.

paymentMethodId

string

ID qui identifie de manière unique le mode de paiement utilisé pour la facture.

paymentMethodType

string

Type de mode de paiement.

paymentType

string

Type de paiement.

PaymentMethodFamily

Famille de modes de paiement.

Valeur Description
CheckWire
CreditCard
Credits
DirectDebit
EWallet
None
Other
TaskOrder

RebillDetails

Détails du refacturation d’une facture.

Nom Type Description
creditNoteDocumentId

string

ID de note de crédit.

invoiceDocumentId

string

ID de la facture.

rebillDetails

RebillDetails

Détails du refacturation d’une facture.

RefundDetails

Détails d’une demande de remboursement.

Nom Type Description
amountRefunded

AmountRefunded

Montant remboursé.

amountRequested

AmountRequested

Montant du remboursement demandé.

approvedOn

string (date-time)

Date à laquelle le remboursement a été approuvé.

completedOn

string (date-time)

Date à laquelle le remboursement a été effectué.

rebillInvoiceId

string

ID de facture de la facture de refacturation pour un remboursement.

refundOperationId

string

ID de l’opération de remboursement.

refundReason

RefundReasonCode

Motif du remboursement.

refundStatus

RefundStatus

État de la demande de remboursement.

requestedOn

string (date-time)

Date à laquelle le remboursement a été demandé.

transactionCount

integer (int32)

Nombre de transactions remboursées.

RefundReasonCode

Motif du remboursement.

Valeur Description
AccidentalConversion
AccidentalPurchase
ForgotToCancel
Other
UnclearDocumentation
UnclearPricing

RefundStatus

État de la demande de remboursement.

Valeur Description
Approved
Cancelled
Completed
Declined
Expired
Other
Pending

SpecialTaxationType

Identifie le type de calcul fiscal utilisé pour la facture. Le champ s’applique uniquement aux factures avec une logique de calcul fiscal spéciale.

Valeur Description
InvoiceLevel
SubtotalLevel

SubTotal

Montant avant impôts dû. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

Nom Type Description
currency

string

Devise de la valeur de montant.

value

number

Valeur du montant. Par exemple, si la devise est USD, une valeur de 600 $ serait de 600,00 $.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string (date-time)

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string (date-time)

Horodatage de la dernière modification de ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.

TaxAmount

Montant de la taxe facturée pour la période de facturation. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

Nom Type Description
currency

string

Devise de la valeur de montant.

value

number

Valeur du montant. Par exemple, si la devise est USD, une valeur de 600 $ serait de 600,00 $.

TotalAmount

Montant dû lors de la génération de la facture. Ce champ s’applique aux comptes de facturation avec le type de contrat Client Microsoft.

Nom Type Description
currency

string

Devise de la valeur de montant.

value

number

Valeur du montant. Par exemple, si la devise est USD, une valeur de 600 $ serait de 600,00 $.