Invoices - List By Billing Subscription

Service:

Billing

Version d'API:

2024-04-01

Répertorie les factures d’un abonnement.

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

Avec des paramètres facultatifs:

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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string	ID qui identifie de façon unique un abonnement de facturation. Modèle d’expression régulière: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
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

InvoicesListByBillingSubscription

Exemple de requête

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

Exemple de réponse

Code d’état:

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

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.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

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.

Nom	Type	Description
DRS	string
ENF	string
Other	string

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 à laquelle le paiement a été tenté.
failedPaymentReason	FailedPaymentReason	Raison pour laquelle le paiement a échoué.

FailedPaymentReason

Raison pour laquelle le paiement a échoué.

Nom	Type	Description
BankDeclined	string
CardExpired	string
IncorrectCardDetails	string
Other	string

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	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.

Nom	Type	Description
CreditNote	string
Invoice	string
Other	string
Summary	string
TaxReceipt	string
Transactions	string
VoidNote	string

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 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 à laquelle la facture a été générée.
invoicePeriodEndDate	string	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 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.

Nom	Type	Description
Due	string
Locked	string
Other	string
OverDue	string
Paid	string
Void	string

InvoiceType

Type de facture.

Nom	Type	Description
AzureMarketplace	string
AzureServices	string
AzureSupport	string
Other	string

Payment

Paiement par facture.

Nom	Type	Description
amount	Amount	Montant payé.
date	string	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.

Nom	Type	Description
CheckWire	string
CreditCard	string
Credits	string
DirectDebit	string
EWallet	string
None	string
Other	string
TaskOrder	string

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 à laquelle le remboursement a été approuvé.
completedOn	string	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 à laquelle le remboursement a été demandé.
transactionCount	integer	Nombre de transactions remboursées.

RefundReasonCode

Motif du remboursement.

Nom	Type	Description
AccidentalConversion	string
AccidentalPurchase	string
ForgotToCancel	string
Other	string
UnclearDocumentation	string
UnclearPricing	string

RefundStatus

État de la demande de remboursement.

Nom	Type	Description
Approved	string
Cancelled	string
Completed	string
Declined	string
Expired	string
Other	string
Pending	string

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.

Nom	Type	Description
InvoiceLevel	string
SubtotalLevel	string

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	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	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 $.