Получение позиций из счета за оплачиваемое потребление продуктов на коммерческой платформе

Статья
04/26/2024

Примечание.

Этот API по-прежнему можно использовать после 30 сентября 2024 г. для новых данных об использовании коммерции, созданных до сентября 2022 г. Выберите правильную версию на основе следующих сведений:

Чтобы получить доступ к элементам линии ежедневного использования для счетов с сентября 2022 по сентябрь 2024 г., используйте этот API до 30 сентября 2024 г., если вы еще не перешли на API версии 2 GA.
Для периодов выставления счетов до сентября 2022 г. получите ежедневные категории строк использования только с помощью этого API.
Чтобы получить ежедневно оцененные элементы строки использования для счетов с сентября 2022 года, используйте только API версии 2 GA.

Чтобы подготовиться к новым API, выполните следующую ссылку:

Выставленные счета и неоплачиваемые ежедневные оценки API выверки использования версии 2 (GA)

Вы можете использовать следующие методы, чтобы получить коллекцию сведений о строках счетов по коммерческому потреблению (также известных как закрытые элементы линии ежедневного использования) для указанного счета.

Внимание

Данные о ежедневном использовании не включают расходы на эти продукты:

Резервирование Azure
Экономичный план Azure
Office
Dynamics
Microsoft Power Apps
Программное обеспечение с бессрочной лицензией
Подписка на программное обеспечение
Сторонний продукт SaaS

Необходимые компоненты

Учетные данные, описанные в статье о проверке подлинности в Центре партнеров. Этот сценарий поддерживает проверку подлинности с помощью автономных учетных данных приложения и приложения и пользователя.
Идентификатор счета, для получения элементов строки.

C#

Чтобы получить элементы коммерческой строки для указанного счета, необходимо получить объект счета:

Вызовите метод ById, чтобы получить интерфейс для операций с счетом для указанного счета.
Вызовите метод Get или GetAsync, чтобы получить объект счета. Объект счета содержит все сведения для указанного счета.

Поставщик определяет источник сведений о выставлении счетов (например, один раз). Объект InvoiceLineItemType указывает тип (например, UsageLineItem).

В следующем примере кода для обработки коллекции элементов строк используется цикл foreach . Для каждого объекта InvoiceLineItemType извлекается отдельная коллекция элементов строки.

Чтобы получить коллекцию строковых элементов, соответствующих экземпляру InvoiceDetail :

Передайте параметр BillingProvider и InvoiceLineItemType экземпляра методу By.
Вызовите метод Get или GetAsync, чтобы получить связанные элементы строки.
Создайте перечислитель для обхода коллекции, как показано в следующем примере.

// IAggregatePartner partnerOperations;
// string invoiceId;
// string curencyCode;
// string period;
// int pageMaxSizeReconLineItems = 2000;

// all the operations executed on this partner operation instance will share the same correlation Id but will differ in request Id
IPartner scopedPartnerOperations = partnerOperations.With(RequestContextFactory.Instance.Create(Guid.NewGuid()));

var seekBasedResourceCollection = scopedPartnerOperations.Invoices.ById(invoiceId).By("onetime", "usagelineitems", curencyCode, period, pageMaxSizeReconLineItems).Get();

var fetchNext = true;

ConsoleKeyInfo keyInfo;

var itemNumber = 1;
while (fetchNext)
{
    Console.Out.WriteLine("\tLine line items count: " + seekBasedResourceCollection.Items.Count());

    seekBasedResourceCollection.Items.ToList().ForEach(item =>
    {
        // Instance of type DailyRatedUsageLineItem
        if (item is DailyRatedUsageLineItem)
        {
            Type t = typeof(DailyRatedUsageLineItem);
            PropertyInfo[] properties = t.GetProperties();

            foreach (PropertyInfo property in properties)
            {
                // Insert code here to work with the line item properties
            }
        }
        itemNumber++;
    });

    Console.Out.WriteLine("\tPress any key to fetch next data. Press the Escape (Esc) key to quit: \n");
    keyInfo = Console.ReadKey();

    if (keyInfo.Key == ConsoleKey.Escape)
    {
        break;
    }

    fetchNext = !string.IsNullOrWhiteSpace(seekBasedResourceCollection.ContinuationToken);

    if (fetchNext)
    {
        if (seekBasedResourceCollection.Links.Next.Headers != null && seekBasedResourceCollection.Links.Next.Headers.Any())
        {
            seekBasedResourceCollection = scopedPartnerOperations.Invoices.ById(invoiceId).By("onetime", "usagelineitems", curencyCode, period, pageMaxSizeReconLineItems).Seek(seekBasedResourceCollection.ContinuationToken, SeekOperation.Next);
        }
    }
}

См. пример:

Пример: тестовое приложение консоли
Проект: примеры пакета SDK центра партнеров
Класс: GetBilledConsumptionReconLineItemsPaging.cs

Запрос REST

Синтаксис запроса

Используйте первый синтаксис, чтобы вернуть полный список каждого элемента строки для заданного счета. В больших счетах используется второй синтаксис с указанным размером и смещением на основе 0, чтобы вернуть список позиций в строках с разбивкой на страницы. Используйте третий синтаксис, чтобы получить следующую страницу элементов линии рекогносцировки с помощью seekOperation = "Next".

Способ	URI запроса
GET	{baseURL}/v1/invoices/{invoice-id}/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode} HTTP/1.1
GET	{baseURL}/v1/invoices/{invoice-id}/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&size={size} HTTP/1.1
GET	{baseURL}/v1/invoices/{invoice-id}/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&size={size}&seekOperation=Next

Параметры универсального кода ресурса (URI)

При создании запроса используйте следующие параметры URI и запроса.

Имя.	Type	Обязательно	Описание
invoice-id	строка	Да	Строка, идентифицирующая счет.
поставщик	строка	Да	Поставщик: OneTime.
invoice-line-item-type	строка	Да	Тип сведений о счете: UsageLineItems.
currencyCode	строка	Да	Код валюты для выставленных счетов элементов строки.
Период	строка	Да	Период выставления счетов. пример: current, previous.
size	number	No	Максимальное количество возвращаемых элементов. Размер по умолчанию — 2000
seekOperation	строка	Нет	Задайте метод seekOperation=Далее, чтобы получить следующую страницу элементов линии рекогносцирования.

Заголовки запросов

Дополнительные сведения см. в статье о заголовках REST Центра партнеров.

Текст запроса

Нет.

Ответ REST

При успешном выполнении ответ содержит коллекцию сведений о элементе строки.

Для элемента строки ChargeType значение покупки сопоставляется с New. Возвращаемое значение сопоставляется с Отменой.

Коды успешного выполнения и ошибок в ответе

Каждый ответ содержит код состояния HTTP, указывающий на успешность или сбой, а также другие сведения об отладке. Используйте средство трассировки сети для чтения этого кода, типа ошибки и других параметров. Полный список ответов есть в статье Коды ошибок REST в Центре партнеров.

Примеры REST

Пример ответа запроса 1

Ниже приведены сведения об этом примере запроса REST и ответа.

Поставщик: OneTime
InvoiceLineItemType: UsageLineItems
Период: предыдущий

Пример запроса 1

GET https://api.partnercenter.microsoft.com/v1/invoices/T000001234/lineitems?provider=onetime&invoicelineitemtype=usagelineitems&currencycode=usd&period=previous&size=2000 HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 1234ecb8-37af-45f4-a1a1-358de3ca2b9e
MS-CorrelationId: 5e612512-4345-4bb0-866e-47aeda031234
X-Locale: en-US
MS-PartnerCenter-Application: Partner Center .NET SDK Samples
Host: api.partnercenter.microsoft.com