Поделиться через

Invoices - List By Billing Account

  • Ссылка
Служба:
Billing
Версия API:
2024-04-01

Перечисляет счета для учетной записи выставления счетов для заданной даты начала и окончания. Эта операция поддерживается для учетных записей выставления счетов с типом соглашения Microsoft Partner Agreement, Клиентским соглашением Майкрософт или программой Microsoft Online Services.

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}

Параметры URI

Имя В Обязательно Тип Описание
billingAccountName
 path True

string

Идентификатор, который однозначно идентифицирует учетную запись выставления счетов.

Шаблон регулярного выражения: ^([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

Версия API, используемая с клиентским запросом. Текущая версия — 2024-04-01.
count
 query

boolean

Параметр запроса счетчика позволяет клиентам запрашивать количество соответствующих ресурсов, включенных в ответ.
filter
 query

string

Параметр запроса фильтра позволяет клиентам фильтровать коллекцию ресурсов, адресованных URL-адресом запроса.
orderBy
 query

string

Параметр запроса orderby позволяет клиентам запрашивать ресурсы в определенном порядке.
periodEndDate
 query

string

date

Дата окончания периода выставления счетов, для которого создается счет. Дата находится в формате MM-DD-YYYY.
periodStartDate
 query

string

date

Дата начала периода выставления счетов, для которого создается счет. Дата находится в формате MM-DD-YYYY.
search
 query

string

Параметр запроса поиска позволяет клиентам запрашивать элементы в коллекции, соответствующее выражению свободного текста. поиск поддерживается только для строковых полей.
skip
 query

integer

int64

Параметр пропуска запроса запрашивает количество элементов в запрашиваемой коллекции, которые должны быть пропущены и не включены в результат.
top
 query

integer

int64

Верхний параметр запроса запрашивает количество элементов в запрашиваемой коллекции, которые будут включены в результат. Максимальное поддерживаемое значение для верхней части — 50.

Ответы

Имя Тип Описание
200 OK

InvoiceListResult

Список счетов.
Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

Примеры

InvoicesListByBillingAccount

Образец запроса

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

Пример ответа

Код состояния:
200 
{
  "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"
    }
  ]
}

Определения

Имя Описание
Amount

Сумма.
AmountDue

Сумма по состоянию на данный момент.
AmountRefunded

Сумма возвращена.
AmountRequested

Запрошенная сумма возмещения.
AzurePrepaymentApplied

Сумма предоплаты Azure, примененная к оплате. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.
BilledAmount

Общая плата за период выставления счетов.
createdByType

Тип удостоверения, создавшего ресурс.
CreditAmount

Общий возврат возврата и отмены в течение периода выставления счетов. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.
DocumentSource

Источник документа. ENF для Бразилии и DRS для остальной части мира.
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Ответ на ошибку
FailedPayment

Сбой платежа.
FailedPaymentReason

Причина, по которой не удалось выполнить платеж.
FreeAzureCreditApplied

Сумма бесплатных кредитов Azure, применяемых к расходам. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.
Invoice

Счет.
InvoiceDocument

Свойства документа.
InvoiceDocumentType

Тип документа.
InvoiceListResult

Контейнер для списка ресурсов
InvoiceProperties

Счет.
InvoiceStatus

Текущее состояние счета.
InvoiceType

Тип счета.
Payment

Платеж по счету.
PaymentMethodFamily

Семейство методов оплаты.
RebillDetails

Сведения о перераспреждаемом счете.
RefundDetails

Сведения о запросе на возврат средств.
RefundReasonCode

Причина возврата средств.
RefundStatus

Состояние запроса на возврат средств.
SpecialTaxationType

Определяет тип налогового расчета, используемого для счета. Поле применимо только к счетам с специальной логикой расчета налогов.
SubTotal

Сумма до уплаты налогов. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.
systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.
TaxAmount

Сумма налога, взимаемая за период выставления счетов. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.
TotalAmount

Сумма, полученная при создании счета. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.

Amount

Сумма.

Имя Тип Описание
currency

string

Валюта для значения суммы.
value

number

Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00.

AmountDue

Сумма по состоянию на данный момент.

Имя Тип Описание
currency

string

Валюта для значения суммы.
value

number

Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00.

AmountRefunded

Сумма возвращена.

Имя Тип Описание
currency

string

Валюта для значения суммы.
value

number

Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00.

AmountRequested

Запрошенная сумма возмещения.

Имя Тип Описание
currency

string

Валюта для значения суммы.
value

number

Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00.

AzurePrepaymentApplied

Сумма предоплаты Azure, примененная к оплате. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.

Имя Тип Описание
currency

string

Валюта для значения суммы.
value

number

Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00.

BilledAmount

Общая плата за период выставления счетов.

Имя Тип Описание
currency

string

Валюта для значения суммы.
value

number

Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00.

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

CreditAmount

Общий возврат возврата и отмены в течение периода выставления счетов. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.

Имя Тип Описание
currency

string

Валюта для значения суммы.
value

number

Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00.

DocumentSource

Источник документа. ENF для Бразилии и DRS для остальной части мира.

Имя Тип Описание
DRS

string

ENF

string

Other

string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

FailedPayment

Сбой платежа.

Имя Тип Описание
date

string

Дата попытки оплаты.
failedPaymentReason

FailedPaymentReason

Причина, по которой не удалось выполнить платеж.

FailedPaymentReason

Причина, по которой не удалось выполнить платеж.

Имя Тип Описание
BankDeclined

string

CardExpired

string

IncorrectCardDetails

string

Other

string

FreeAzureCreditApplied

Сумма бесплатных кредитов Azure, применяемых к расходам. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.

Имя Тип Описание
currency

string

Валюта для значения суммы.
value

number

Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00.

Invoice

Счет.

Имя Тип Описание
id

string

Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

Имя ресурса
properties

InvoiceProperties

Счет.
systemData

systemData

Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags

object

Словарь метаданных, связанных с ресурсом. Он не может быть заполнен для всех типов ресурсов. Максимальная длина ключа и значения, поддерживаемая 256 символами. Ключи или значение не должны пустыми значениями и значениями NULL. Ключи не могут содержать <> % & \ ? /
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

InvoiceDocument

Свойства документа.

Имя Тип Описание
documentNumbers

string[]

Номера документов для документа счета.
externalUrl

string

URL-адрес для скачивания документа счета, если источник является внешним для Microsoft.Billing.
kind

InvoiceDocumentType

Тип документа.
name

string

Идентификатор, который однозначно идентифицирует документ счета. Этот идентификатор может быть идентификатором PDF-файла счета, кредитной заметки или налоговой квитанции.
source

DocumentSource

Источник документа. ENF для Бразилии и DRS для остальной части мира.
url

string

URL-адрес для скачивания документа счета, если источник является внутренним в Microsoft.Billing.

InvoiceDocumentType

Тип документа.

Имя Тип Описание
CreditNote

string

Invoice

string

Other

string

Summary

string

TaxReceipt

string

Transactions

string

VoidNote

string

InvoiceListResult

Контейнер для списка ресурсов

Имя Тип Описание
nextLink

string

Ссылка (URL-адрес) на следующую страницу результатов.
value

Invoice[]

Список ресурсов.

InvoiceProperties

Счет.

Имя Тип Описание
amountDue

AmountDue

Сумма по состоянию на данный момент.
azurePrepaymentApplied

AzurePrepaymentApplied

Сумма предоплаты Azure, примененная к оплате. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.
billedAmount

BilledAmount

Общая плата за период выставления счетов.
billedDocumentId

string

Идентификатор активного счета, который изначально выставляется после того, как этот счет был отменен. Это поле применимо только к счетам void.
billingProfileDisplayName

string

Имя профиля выставления счетов, для которого создается счет.
billingProfileId

string

Идентификатор профиля выставления счетов, для которого создается счет.
creditAmount

CreditAmount

Общий возврат возврата и отмены в течение периода выставления счетов. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.
creditForDocumentId

string

Идентификатор счета, который был отменен, и эта кредитная записка была выдана в результате. Это поле применимо только к кредитным заметкам.
documentType

InvoiceDocumentType

Тип документа.
documents

InvoiceDocument[]

Список документов, доступных для скачивания и просмотра, таких как счет, кредитная заметка или налоговая квитанция.
dueDate

string

Дата выполнения счета.
failedPayments

FailedPayment[]

Список неудачных платежей.
freeAzureCreditApplied

FreeAzureCreditApplied

Сумма бесплатных кредитов Azure, применяемых к расходам. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.
invoiceDate

string

Дата создания счета.
invoicePeriodEndDate

string

Дата окончания периода выставления счетов, для которого создается счет. Дата находится в формате MM-DD-YYYY.
invoicePeriodStartDate

string

Дата начала периода выставления счетов, для которого создается счет. Дата находится в формате MM-DD-YYYY.
invoiceType

InvoiceType

Тип счета.
isMonthlyInvoice

boolean

Указывает, создается ли счет в рамках ежемесячного цикла выставления счетов или нет. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.
payments

Payment[]

Список платежей.
purchaseOrderNumber

string

Необязательный номер заказа на покупку для счета.
rebillDetails

RebillDetails

Сведения о реберилле для счета.
refundDetails

RefundDetails

Сведения о запросе на возврат средств.
specialTaxationType

SpecialTaxationType

Определяет тип налогового расчета, используемого для счета. Поле применимо только к счетам с специальной логикой расчета налогов.
status

InvoiceStatus

Текущее состояние счета.
subTotal

SubTotal

Сумма до уплаты налогов. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.
subscriptionDisplayName

string

Имя подписки на выставление счетов, для которой создается счет.
subscriptionId

string

Идентификатор подписки, для которой создается счет.
taxAmount

TaxAmount

Сумма налога, взимаемая за период выставления счетов. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.
totalAmount

TotalAmount

Сумма, полученная при создании счета. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.

InvoiceStatus

Текущее состояние счета.

Имя Тип Описание
Due

string

Locked

string

Other

string

OverDue

string

Paid

string

Void

string

InvoiceType

Тип счета.

Имя Тип Описание
AzureMarketplace

string

AzureServices

string

AzureSupport

string

Other

string

Payment

Платеж по счету.

Имя Тип Описание
amount

Amount

Платная сумма.
date

string

Дата, когда была выполнена оплата.
paymentMethodFamily

PaymentMethodFamily

Семейство методов оплаты.
paymentMethodId

string

Идентификатор, который однозначно идентифицирует метод оплаты, используемый для счета.
paymentMethodType

string

Тип метода оплаты.
paymentType

string

Тип оплаты.

PaymentMethodFamily

Семейство методов оплаты.

Имя Тип Описание
CheckWire

string

CreditCard

string

Credits

string

DirectDebit

string

EWallet

string

None

string

Other

string

TaskOrder

string

RebillDetails

Сведения о перераспреждаемом счете.

Имя Тип Описание
creditNoteDocumentId

string

Идентификатор кредитной заметки.
invoiceDocumentId

string

Идентификатор счета.
rebillDetails

RebillDetails

Сведения о перераспреждаемом счете.

RefundDetails

Сведения о запросе на возврат средств.

Имя Тип Описание
amountRefunded

AmountRefunded

Сумма возвращена.
amountRequested

AmountRequested

Запрошенная сумма возмещения.
approvedOn

string

Дата утверждения возврата.
completedOn

string

Дата завершения возврата.
rebillInvoiceId

string

Идентификатор счета-фактуры для возврата средств.
refundOperationId

string

Идентификатор операции возврата.
refundReason

RefundReasonCode

Причина возврата средств.
refundStatus

RefundStatus

Состояние запроса на возврат средств.
requestedOn

string

Дата запроса на возврат средств.
transactionCount

integer

Количество возвращенных транзакций.

RefundReasonCode

Причина возврата средств.

Имя Тип Описание
AccidentalConversion

string

AccidentalPurchase

string

ForgotToCancel

string

Other

string

UnclearDocumentation

string

UnclearPricing

string

RefundStatus

Состояние запроса на возврат средств.

Имя Тип Описание
Approved

string

Cancelled

string

Completed

string

Declined

string

Expired

string

Other

string

Pending

string

SpecialTaxationType

Определяет тип налогового расчета, используемого для счета. Поле применимо только к счетам с специальной логикой расчета налогов.

Имя Тип Описание
InvoiceLevel

string

SubtotalLevel

string

SubTotal

Сумма до уплаты налогов. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.

Имя Тип Описание
currency

string

Валюта для значения суммы.
value

number

Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00.

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).
createdBy

string

Удостоверение, создающее ресурс.
createdByType

createdByType

Тип удостоверения, создавшего ресурс.
lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)
lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.
lastModifiedByType

createdByType

Тип удостоверения, который последний раз изменил ресурс.

TaxAmount

Сумма налога, взимаемая за период выставления счетов. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.

Имя Тип Описание
currency

string

Валюта для значения суммы.
value

number

Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00.

TotalAmount

Сумма, полученная при создании счета. Это поле применимо к учетным записям выставления счетов с типом клиентского соглашения Майкрософт.

Имя Тип Описание
currency

string

Валюта для значения суммы.
value

number

Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00.