Invoices - List By Billing Profile
Elenca le fatture per un profilo di fatturazione per una data di inizio e una data di fine specificata. L'operazione è supportata per gli account di fatturazione con tipo di contratto Contratto Microsoft Partner o Contratto del cliente Microsoft.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices?api-version=2020-05-01&periodStartDate={periodStartDate}&periodEndDate={periodEndDate}
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
billing
|
path | True |
string |
ID che identifica in modo univoco un account di fatturazione. |
billing
|
path | True |
string |
ID che identifica in modo univoco un profilo di fatturazione. |
api-version
|
query | True |
string |
Versione dell'API da usare con la richiesta client. La versione corrente è 2020-05-01. |
period
|
query | True |
string |
Data di fine per recuperare le fatture. La data deve essere specificata in formato MM-DD-AAAA. |
period
|
query | True |
string |
Data di inizio per recuperare le fatture. La data deve essere specificata in formato MM-DD-AAAA. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
OK. La richiesta ha avuto esito positivo. |
|
Other Status Codes |
Risposta di errore che descrive perché l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
Invoices |
Invoices |
InvoicesListByBillingProfile
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices?api-version=2020-05-01&periodStartDate=2018-01-01&periodEndDate=2018-06-30
Sample Response
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383723",
"name": "1383723",
"type": "Microsoft.Billing/billingAccounts/invoices",
"properties": {
"dueDate": "2018-01-16T17:32:28Z",
"invoiceDate": "2018-01-01T17:32:28Z",
"status": "Due",
"amountDue": {
"currency": "USD",
"value": 8.53
},
"billedAmount": {
"currency": "USD",
"value": 33.99
},
"azurePrepaymentApplied": {
"currency": "USD",
"value": 25.46
},
"creditAmount": {
"currency": "USD",
"value": 1
},
"freeAzureCreditApplied": {
"currency": "USD",
"value": 0
},
"subTotal": {
"currency": "USD",
"value": 33.99
},
"taxAmount": {
"currency": "USD",
"value": 0
},
"totalAmount": {
"currency": "USD",
"value": 7.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",
"documentType": "Invoice",
"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": 1
},
"paymentMethodFamily": "CreditCard",
"paymentMethodType": "visa"
}
]
}
},
{
"id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383724",
"name": "1383724",
"type": "Microsoft.Billing/billingAccounts/invoices",
"properties": {
"dueDate": "2018-03-01T17: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-02-01T17:32:28Z",
"invoicePeriodEndDate": "2018-02-28T17:32:28Z",
"isMonthlyInvoice": true,
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
"billingProfileDisplayName": "Contoso Operations Billing",
"purchaseOrderNumber": "123456",
"documentType": "Invoice",
"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"
}
]
}
}
]
}
InvoicesListByBillingProfileWithRebillDetails
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices?api-version=2020-05-01&periodStartDate=2018-01-01&periodEndDate=2018-06-30
Sample Response
{
"value": [
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/I000003",
"name": "I000003",
"type": "Microsoft.Billing/billingAccounts/invoices",
"properties": {
"dueDate": "2018-01-16T17:32:28Z",
"invoiceDate": "2018-01-01T17:32:28Z",
"status": "Due",
"amountDue": {
"currency": "USD",
"value": 8.53
},
"billedAmount": {
"currency": "USD",
"value": 33.99
},
"azurePrepaymentApplied": {
"currency": "USD",
"value": 25.46
},
"creditAmount": {
"currency": "USD",
"value": 1
},
"freeAzureCreditApplied": {
"currency": "USD",
"value": 0
},
"subTotal": {
"currency": "USD",
"value": 33.99
},
"taxAmount": {
"currency": "USD",
"value": 0
},
"totalAmount": {
"currency": "USD",
"value": 7.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",
"documentType": "Invoice",
"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": 1
},
"paymentMethodFamily": "CreditCard",
"paymentMethodType": "visa"
}
],
"rebillDetails": {
"creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/CreditNote2",
"invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/I000002",
"rebillDetails": {
"creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/CreditNote1",
"invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/I000001",
"rebillDetails": null
}
}
}
},
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383724",
"name": "1383724",
"type": "Microsoft.Billing/billingAccounts/invoices",
"properties": {
"dueDate": "2018-03-01T17: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-02-01T17:32:28Z",
"invoicePeriodEndDate": "2018-02-28T17:32:28Z",
"isMonthlyInvoice": true,
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
"billingProfileDisplayName": "Contoso Operations Billing",
"purchaseOrderNumber": "123456",
"documentType": "Invoice",
"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"
}
]
}
}
]
}
Definizioni
Nome | Descrizione |
---|---|
Amount |
Importo. |
Document |
Proprietà di un documento. |
Document |
Origine del documento. ENF per Brasile e DRS per il resto del mondo. |
Document |
Tipo del documento. |
Error |
Dettagli dell'errore. |
Error |
Risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore. |
Error |
|
Invoice |
Fattura. |
Invoice |
Tipo del documento. |
Invoice |
Elenco delle fatture. |
Invoice |
Stato corrente della fattura. |
Invoice |
Tipo di fattura. |
Payment |
Famiglia di metodi di pagamento. |
Payment |
Proprietà di un pagamento. |
Rebill |
Dettagli della fattura. |
Amount
Importo.
Nome | Tipo | Descrizione |
---|---|---|
currency |
string |
Valuta per il valore dell'importo. |
value |
number |
Valore quantità. |
Document
Proprietà di un documento.
Nome | Tipo | Descrizione |
---|---|---|
kind |
Tipo del documento. |
|
source |
Origine del documento. ENF per Brasile e DRS per il resto del mondo. |
|
url |
string |
URL documento. |
DocumentSource
Origine del documento. ENF per Brasile e DRS per il resto del mondo.
Nome | Tipo | Descrizione |
---|---|---|
DRS |
string |
|
ENF |
string |
DocumentType
Tipo del documento.
Nome | Tipo | Descrizione |
---|---|---|
CreditNote |
string |
|
Invoice |
string |
|
TaxReceipt |
string |
|
VoidNote |
string |
ErrorDetails
Dettagli dell'errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore. |
details |
Dettagli secondari dell'errore. |
|
message |
string |
Messaggio di errore che indica perché l'operazione non è riuscita. |
target |
string |
Destinazione dell'errore specifico. |
ErrorResponse
Risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.
Nome | Tipo | Descrizione |
---|---|---|
error |
Dettagli dell'errore. |
ErrorSubDetails
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore. |
message |
string |
Messaggio di errore che indica perché l'operazione non è riuscita. |
target |
string |
Destinazione dell'errore specifico. |
Invoice
Fattura.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID risorsa. |
name |
string |
Nome risorsa. |
properties.amountDue |
Importo dovuto a questo momento. |
|
properties.azurePrepaymentApplied |
Importo del pagamento anticipato di Azure applicato agli addebiti. Questo campo è applicabile agli account di fatturazione con il tipo di contratto Contratto del cliente Microsoft. |
|
properties.billedAmount |
Addebiti totali per il periodo di fatturazione della fattura. |
|
properties.billedDocumentId |
string |
ID della fattura attiva fatturata originariamente dopo che questa fattura è stata annullata. Questo campo è applicabile solo alle fatture void. |
properties.billingProfileDisplayName |
string |
Nome del profilo di fatturazione per il quale viene generata la fattura. |
properties.billingProfileId |
string |
ID del profilo di fatturazione per il quale viene generata la fattura. |
properties.creditAmount |
Rimborso totale per i restituzioni e gli annullamenti durante il periodo di fatturazione della fattura. Questo campo è applicabile agli account di fatturazione con il tipo di contratto Contratto del cliente Microsoft. |
|
properties.creditForDocumentId |
string |
Id della fattura che è stata annullata e questa nota di credito è stata emessa di conseguenza. Questo campo è applicabile solo alle note di credito. |
properties.documentType |
Tipo del documento. |
|
properties.documents |
Document[] |
Elenco di documenti disponibili per scaricare, ad esempio la fattura e la ricevuta fiscale. |
properties.dueDate |
string |
Data di scadenza della fattura. |
properties.freeAzureCreditApplied |
Importo di crediti di Azure gratuiti applicati agli addebiti. Questo campo è applicabile agli account di fatturazione con il tipo di contratto Contratto del cliente Microsoft. |
|
properties.invoiceDate |
string |
Data di generazione della fattura. |
properties.invoicePeriodEndDate |
string |
Data di fine del periodo di fatturazione per cui viene generata la fattura. |
properties.invoicePeriodStartDate |
string |
Data di inizio del periodo di fatturazione per cui viene generata la fattura. |
properties.invoiceType |
Tipo di fattura. |
|
properties.isMonthlyInvoice |
boolean |
Specifica se la fattura viene generata come parte del ciclo di fatturazione mensile o meno. Questo campo è applicabile agli account di fatturazione con il tipo di contratto Contratto del cliente Microsoft. |
properties.payments |
Elenco dei pagamenti. |
|
properties.purchaseOrderNumber |
string |
Numero di ordine di acquisto facoltativo per la fattura. |
properties.rebillDetails |
<string,
Rebill |
Dettagli della fattura. |
properties.status |
Stato corrente della fattura. |
|
properties.subTotal |
Importo pre-imposta dovuto. Questo campo è applicabile agli account di fatturazione con il tipo di contratto Contratto del cliente Microsoft. |
|
properties.subscriptionId |
string |
ID della sottoscrizione per cui viene generata la fattura. |
properties.taxAmount |
Importo dell'imposta addebitata per il periodo di fatturazione. Questo campo è applicabile agli account di fatturazione con il tipo di contratto Contratto del cliente Microsoft. |
|
properties.totalAmount |
Importo dovuto al momento della generazione della fattura. Questo campo è applicabile agli account di fatturazione con il tipo di contratto Contratto del cliente Microsoft. |
|
type |
string |
Tipo di risorsa. |
InvoiceDocumentType
Tipo del documento.
Nome | Tipo | Descrizione |
---|---|---|
CreditNote |
string |
|
Invoice |
string |
InvoiceListResult
Elenco delle fatture.
Nome | Tipo | Descrizione |
---|---|---|
nextLink |
string |
Collegamento (URL) alla pagina successiva dei risultati. |
totalCount |
number |
Numero totale di record. |
value |
Invoice[] |
Elenco delle fatture. |
InvoiceStatus
Stato corrente della fattura.
Nome | Tipo | Descrizione |
---|---|---|
Due |
string |
|
OverDue |
string |
|
Paid |
string |
|
Void |
string |
InvoiceType
Tipo di fattura.
Nome | Tipo | Descrizione |
---|---|---|
AzureMarketplace |
string |
|
AzureService |
string |
|
AzureSupport |
string |
PaymentMethodFamily
Famiglia di metodi di pagamento.
Nome | Tipo | Descrizione |
---|---|---|
CheckWire |
string |
|
CreditCard |
string |
|
Credits |
string |
|
None |
string |
PaymentProperties
Proprietà di un pagamento.
Nome | Tipo | Descrizione |
---|---|---|
amount |
Importo pagato. |
|
date |
string |
Data in cui è stato effettuato il pagamento. |
paymentMethodFamily |
Famiglia di metodi di pagamento. |
|
paymentMethodType |
string |
Tipo di metodo di pagamento. |
paymentType |
string |
Tipo di pagamento. |
RebillDetails
Dettagli della fattura.
Nome | Tipo | Descrizione |
---|---|---|
creditNoteDocumentId |
string |
ID della nota di credito. |
invoiceDocumentId |
string |
ID della fattura. |
rebillDetails |
<string,
Rebill |
Dettagli della fattura. |