Transactions - List By Invoice
Выводит список транзакций для счета. К транзакциям относятся покупки, возврат средств и плата за использование Azure.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactions?api-version=2024-04-01
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactions?api-version=2024-04-01&filter={filter}&orderBy={orderBy}&top={top}&skip={skip}&count={count}&search={search}
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
billing
|
path | True |
string |
Идентификатор, который однозначно идентифицирует учетную запись выставления счетов. Шаблон регулярного выражения: |
invoice
|
path | True |
string |
Идентификатор, который однозначно идентифицирует счет. Шаблон регулярного выражения: |
api-version
|
query | True |
string |
Версия API, используемая с клиентским запросом. Текущая версия — 2024-04-01. |
count
|
query |
boolean |
Параметр запроса счетчика позволяет клиентам запрашивать количество соответствующих ресурсов, включенных в ответ. |
|
filter
|
query |
string |
Параметр запроса фильтра позволяет клиентам фильтровать коллекцию ресурсов, адресованных URL-адресом запроса. |
|
order
|
query |
string |
Параметр запроса orderby позволяет клиентам запрашивать ресурсы в определенном порядке. |
|
search
|
query |
string |
Параметр запроса поиска позволяет клиентам запрашивать элементы в коллекции, соответствующее выражению свободного текста. поиск поддерживается только для строковых полей. |
|
skip
|
query |
integer int64 |
Параметр пропуска запроса запрашивает количество элементов в запрашиваемой коллекции, которые должны быть пропущены и не включены в результат. |
|
top
|
query |
integer int64 |
Верхний параметр запроса запрашивает количество элементов в запрашиваемой коллекции, которые будут включены в результат. Максимальное поддерживаемое значение для верхней части — 50. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Список транзакций. |
|
Other Status Codes |
Ответ на ошибку, описывающий причину сбоя операции. |
Примеры
TransactionsListByInvoice
Образец запроса
Пример ответа
{
"value": [
{
"id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000",
"name": "41000000-0000-0000-0000-000000000000",
"properties": {
"azureCreditApplied": {
"currency": "USD",
"value": 2000
},
"billingCurrency": "USD",
"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",
"consumptionCommitmentDecremented": {
"currency": "USD",
"value": 100
},
"date": "2023-05-01T00:00:00Z",
"discount": 0.1,
"effectivePrice": {
"currency": "USD",
"value": 10
},
"exchangeRate": 1,
"invoice": "G123456789",
"invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789",
"invoiceSectionDisplayName": "Contoso operations invoiceSection",
"invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000",
"marketPrice": {
"currency": "USD",
"value": 20
},
"partNumber": "0001",
"pricingCurrency": "USD",
"productDescription": "Standard D1, US West 3",
"productFamily": "Storage",
"productTypeId": "A12345",
"productType": "VM Instance",
"quantity": 1,
"servicePeriodStartDate": "2023-05-01T00:00:00Z",
"servicePeriodEndDate": "2023-09-30T00:00:00Z",
"subTotal": {
"currency": "USD",
"value": 4500
},
"tax": {
"currency": "USD",
"value": 500
},
"transactionAmount": {
"currency": "USD",
"value": 5000
},
"transactionType": "Purchase",
"units": 11.25,
"unitOfMeasure": "1 Minute",
"unitType": "1 Runtime Minute"
},
"type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions"
},
{
"id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000",
"name": "51000000-0000-0000-0000-000000000000",
"properties": {
"azureCreditApplied": {
"currency": "USD",
"value": 20
},
"billingCurrency": "USD",
"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",
"consumptionCommitmentDecremented": {
"currency": "USD",
"value": 50
},
"date": "2024-04-01T00:00:00Z",
"discount": 0.1,
"effectivePrice": {
"currency": "USD",
"value": 10
},
"exchangeRate": 1,
"invoice": "pending",
"invoiceSectionDisplayName": "Contoso operations invoiceSection",
"invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000",
"marketPrice": {
"currency": "USD",
"value": 20
},
"partNumber": "0002",
"pricingCurrency": "USD",
"productDescription": "Standard Support",
"productFamily": "Storage",
"productTypeId": "A12345",
"productType": "VM Instance",
"quantity": 1,
"servicePeriodStartDate": "2023-05-01T00:00:00Z",
"servicePeriodEndDate": "2023-09-30T00:00:00Z",
"subTotal": {
"currency": "USD",
"value": 45
},
"tax": {
"currency": "USD",
"value": 5
},
"transactionAmount": {
"currency": "USD",
"value": 50
},
"transactionType": "Cancel",
"units": 1.25,
"unitOfMeasure": "1 Minute",
"unitType": "1 Runtime Minute"
},
"type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions"
}
]
}
Определения
Имя | Описание |
---|---|
Amount |
Сумма возвращена. |
Amount |
Запрошенная сумма возмещения. |
Azure |
Сумма всех кредитов Azure автоматически применяется к этой транзакции. |
Consumption |
Сумма обязательств по потреблению Microsoft Azure (MACC) через транзакцию. |
created |
Тип удостоверения, создавшего ресурс. |
Credit |
Тип кредита транзакции. Применяется только к кредитным транзакциям. |
Effective |
Цена продукта после применения любых скидок. |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Ответ на ошибку |
Market |
Розничная цена продукта. |
Refund |
Сведения о возврате средств для транзакции. |
Special |
Определяет тип налогового расчета, используемого для счета. Поле применимо только к счетам с специальной логикой расчета налогов. |
Sub |
Сумма, начисленная до уплаты налогов для транзакции. |
system |
Метаданные, относящиеся к созданию и последнему изменении ресурса. |
Tax |
Сумма налога, примененная к транзакции. |
Transaction |
Транзакция. |
Transaction |
Плата, связанная с транзакцией. |
Transaction |
Тип транзакции, выставленный счет или необязаемый. |
Transaction |
Контейнер для списка ресурсов |
Transaction |
Транзакция. |
AmountRefunded
Сумма возвращена.
Имя | Тип | Описание |
---|---|---|
currency |
string |
Валюта для значения суммы. |
value |
number |
Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00. |
AmountRequested
Запрошенная сумма возмещения.
Имя | Тип | Описание |
---|---|---|
currency |
string |
Валюта для значения суммы. |
value |
number |
Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00. |
AzureCreditApplied
Сумма всех кредитов Azure автоматически применяется к этой транзакции.
Имя | Тип | Описание |
---|---|---|
currency |
string |
Валюта для значения суммы. |
value |
number |
Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00. |
ConsumptionCommitmentDecremented
Сумма обязательств по потреблению Microsoft Azure (MACC) через транзакцию.
Имя | Тип | Описание |
---|---|---|
currency |
string |
Валюта для значения суммы. |
value |
number |
Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00. |
createdByType
Тип удостоверения, создавшего ресурс.
Имя | Тип | Описание |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CreditType
Тип кредита транзакции. Применяется только к кредитным транзакциям.
Имя | Тип | Описание |
---|---|---|
AzureCreditOffer |
string |
|
AzureFreeCredit |
string |
|
Other |
string |
|
Refund |
string |
|
ServiceInterruption |
string |
EffectivePrice
Цена продукта после применения любых скидок.
Имя | Тип | Описание |
---|---|---|
currency |
string |
Валюта для значения суммы. |
value |
number |
Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00. |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ на ошибку
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |
MarketPrice
Розничная цена продукта.
Имя | Тип | Описание |
---|---|---|
currency |
string |
Валюта для значения суммы. |
value |
number |
Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00. |
RefundTransactionDetails
Сведения о возврате средств для транзакции.
Имя | Тип | Описание |
---|---|---|
amountRefunded |
Сумма возвращена. |
|
amountRequested |
Запрошенная сумма возмещения. |
|
refundOperationId |
string |
Идентификатор операции возврата. |
SpecialTaxationType
Определяет тип налогового расчета, используемого для счета. Поле применимо только к счетам с специальной логикой расчета налогов.
Имя | Тип | Описание |
---|---|---|
InvoiceLevel |
string |
|
SubtotalLevel |
string |
SubTotal
Сумма, начисленная до уплаты налогов для транзакции.
Имя | Тип | Описание |
---|---|---|
currency |
string |
Валюта для значения суммы. |
value |
number |
Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00. |
systemData
Метаданные, относящиеся к созданию и последнему изменении ресурса.
Имя | Тип | Описание |
---|---|---|
createdAt |
string |
Метка времени создания ресурса (UTC). |
createdBy |
string |
Удостоверение, создающее ресурс. |
createdByType |
Тип удостоверения, создавшего ресурс. |
|
lastModifiedAt |
string |
Метка времени последнего изменения ресурса (UTC) |
lastModifiedBy |
string |
Идентификатор, который последний раз изменил ресурс. |
lastModifiedByType |
Тип удостоверения, который последний раз изменил ресурс. |
Tax
Сумма налога, примененная к транзакции.
Имя | Тип | Описание |
---|---|---|
currency |
string |
Валюта для значения суммы. |
value |
number |
Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00. |
Transaction
Транзакция.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
Имя ресурса |
properties |
Транзакция. |
|
systemData |
Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy. |
|
tags |
object |
Словарь метаданных, связанных с ресурсом. Он не может быть заполнен для всех типов ресурсов. Максимальная длина ключа и значения, поддерживаемая 256 символами. Ключи или значение не должны пустыми значениями и значениями NULL. Ключи не могут содержать <> % & \ ? / |
type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
TransactionAmount
Плата, связанная с транзакцией.
Имя | Тип | Описание |
---|---|---|
currency |
string |
Валюта для значения суммы. |
value |
number |
Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00. |
TransactionKind
Тип транзакции, выставленный счет или необязаемый.
Имя | Тип | Описание |
---|---|---|
All |
string |
|
Other |
string |
|
Reservation |
string |
TransactionListResult
Контейнер для списка ресурсов
Имя | Тип | Описание |
---|---|---|
nextLink |
string |
Ссылка (URL-адрес) на следующую страницу результатов. |
value |
Список ресурсов. |
TransactionProperties
Транзакция.
Имя | Тип | Описание |
---|---|---|
azureCreditApplied |
Сумма всех кредитов Azure автоматически применяется к этой транзакции. |
|
azurePlan |
string |
Сведения о плане Azure. |
billingCurrency |
string |
Код ISO 4217 для валюты, в которой выставляется плата за эту транзакцию. |
billingProfileDisplayName |
Имя профиля выставления счетов. |
|
billingProfileId |
string |
Полный идентификатор, который однозначно идентифицирует профиль выставления счетов. |
consumptionCommitmentDecremented |
Сумма обязательств по потреблению Microsoft Azure (MACC) через транзакцию. |
|
creditType |
Тип кредита транзакции. Применяется только к кредитным транзакциям. |
|
customerDisplayName |
string |
Имя клиента. |
customerId |
string |
Полный идентификатор, который однозначно идентифицирует клиента. |
date |
string |
Дата транзакции. |
discount |
number |
Процентная скидка, если она есть, применяется к этой транзакции. |
effectivePrice |
Цена продукта после применения любых скидок. |
|
exchangeRate |
number |
Обменный курс, используемый для преобразования взимаемой суммы в валюту выставления счетов, если применимо. |
invoice |
string |
Имя счета, в котором была выставлена плата за транзакцию или "Ожидание", если транзакция не выставляется. |
invoiceId |
string |
Полный идентификатор счета, по которому выставляется счет. Это поле применимо только для транзакций, которые выставляются в счете. |
invoiceSectionDisplayName |
string |
Имя раздела счета. |
invoiceSectionId |
string |
Полный идентификатор, который однозначно идентифицирует раздел счета. |
isThirdParty |
boolean |
Независимо от того, является ли транзакция стороной. |
kind |
Тип транзакции, выставленный счет или необязаемый. |
|
marketPrice |
Розничная цена продукта. |
|
partNumber |
string |
Часть продукта, для которого произошла транзакция. Поле применимо только для счетов соглашения Enterprise. |
pricingCurrency |
string |
Код ISO 4217 для валюты, в которой цена на продукт. |
productDescription |
string |
Описание продукта, для которого произошла транзакция. |
productFamily |
string |
Семейство продукта, для которого произошла транзакция. |
productType |
string |
Тип продукта, для которого произошла транзакция. |
productTypeId |
string |
Идентификатор типа продукта, для которого произошла транзакция. |
quantity |
integer |
Количество, приобретенное в транзакции. |
reasonCode |
string |
Существует код причины для транзакции. |
refundTransactionDetails |
Сведения о возврате средств для транзакции. |
|
servicePeriodEndDate |
string |
Дата окончания срока продукта или дата окончания месяца, в котором закончилось использование. |
servicePeriodStartDate |
string |
Дата покупки продукта или дата начала месяца, в котором началось использование. |
specialTaxationType |
Определяет тип налогового расчета, используемого для счета. Поле применимо только к счетам с специальной логикой расчета налогов. |
|
subTotal |
Сумма, начисленная до уплаты налогов для транзакции. |
|
tax |
Сумма налога, примененная к транзакции. |
|
transactionAmount |
Плата, связанная с транзакцией. |
|
transactionType |
string |
Тип транзакции. |
unitOfMeasure |
string |
Единица измерения, используемая для выставления счетов за продукт. Например, счета за вычислительные службы выставляются в час. |
unitType |
string |
Описание единицы измерения для данного продукта. |
units |
number |
Количество единиц, используемых для данного продукта. |