Invoices - Download Documents By Billing Account

Hizmet:

Billing

API Sürümü:

2024-04-01

Birden çok fatura belgesini (fatura pdf'si, vergi makbuzları, kredi notları) zip dosyası olarak indirmek için bir URL alır. İşlem, Sözleşme türü Microsoft İş Ortağı Sözleşmesi veya Microsoft Müşteri Sözleşmesi olan ödeme hesapları için desteklenir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
billingAccountName	path	True	string	Bir ödeme hesabını benzersiz olarak tanımlayan kimlik. Normal ifade deseni: ^([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})?)$
api-version	query	True	string	İstemci isteğiyle kullanılacak API sürümü. Geçerli sürüm 2024-04-01'dir.

İstek Gövdesi

Name	Tür	Description
parameters	DocumentDownloadRequest[]	Tek tek belgeler için indirme ayrıntılarının listesi.

Yanıtlar

Name	Tür	Description
200 OK	DocumentDownloadResult	URL'nin süresi dolana kadar bir varlığı indirmek için kullanılabilecek güvenli bir URL.
202 Accepted		İstemcinin işlemin sonucunu görüntülemek için yoklaması için kullanabileceği bir 'Konum' üst bilgisi döndüren bir işlem sonucu kabul edildi. Üst Bilgiler Location: string Retry-After: integer
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Örnekler

InvoicesDownloadDocumentsByBillingAccount

Örnek isteği

HTTP

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

[
  {
    "documentName": "12345678",
    "invoiceName": "G123456789"
  },
  {
    "documentName": "12345678",
    "invoiceName": "G987654321"
  }
]

Örnek yanıt

Durum kodu:

200

{
  "expiryTime": "2023-02-16T17:32:28Z",
  "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r"
}

Durum kodu:

202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/invoiceDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01
Retry-After: 10

Tanımlar

Name	Description
DocumentDownloadRequest	Tek tek belgeler için indirme ayrıntılarının listesi.
DocumentDownloadResult	URL'nin süresi dolana kadar bir varlığı indirmek için kullanılabilecek güvenli bir URL.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı

DocumentDownloadRequest

Tek tek belgeler için indirme ayrıntılarının listesi.

Name	Tür	Description
documentName	string	Bir fatura belgesini benzersiz olarak tanımlayan kimlik. Bu kimlik, fatura PDF'si, alacak dekontu veya vergi makbuzu tanımlayıcısı olabilir. Atlanırsa, faturanın en son fatura PDF'si döndürülür.
invoiceName	string	Bir faturayı benzersiz olarak tanımlayan kimlik.

DocumentDownloadResult

URL'nin süresi dolana kadar bir varlığı indirmek için kullanılabilecek güvenli bir URL.

Name	Tür	Description
expiryTime	string	İndirme URL'sinin süresinin dolacağı UTC saati.
url	string	PDF veya .zip dosyasının URL'si.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.