Obter os itens de linha de consumo comercial não cobrados na fatura

Artigo
04/26/2024

Observação

Após 30 de setembro de 2024, essa API não funcionará mais. Use as informações para escolher sua versão e planejar com antecedência.

Para acessar detalhes de uso diário não faturados para os períodos de faturamento atual e anterior, use esta API. Você pode usá-lo até 30 de setembro de 2024, a menos que você mude para v2 GA antes dessa data.
Para obter o uso diário nominal não faturado para períodos atuais e anteriores, mude para a API v2 GA até 30 de setembro de 2024.

Para ver as etapas de migração da API v2, acesse:

API v2 (GA) de reconciliação de uso nominal diária cobrada e não faturada

Como obter uma coleção de detalhes de itens de linha de consumo comercial não faturados.

Você pode usar os seguintes métodos para obter uma coleção de detalhes de itens de linha de consumo comercial não faturados (também conhecidos como itens de linha de uso aberto) programaticamente.

Importante

Os dados de uso nominal diário não incluem os encargos para estes produtos:

Reserva do Azure
Plano de economia do Azure
Office
Dynamics
Microsoft Power Apps
Software perpétuo
Assinatura de software
Produto SaaS do Marketplace

Observação

Você pode recuperar seus dados de uso diários não faturados por meio da API ou do portal do Partner Center. Pode levar até 24 horas para que os dados fiquem disponíveis. No entanto, pode haver mais atrasos, dependendo da sua localização e quando os medidores relatam o uso.

Às vezes, talvez você não veja os dados de uso não faturados mais recentes até que os dados de uso cobrados do mês anterior sejam entregues. Isso é feito para garantir que os dados de uso faturados sejam entregues dentro do prazo acordado. Depois de receber os dados de uso cobrados, você poderá recuperar todos os dados de uso não faturados atualizados do início do mês.

Pré-requisitos

Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário oferece suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.

C#

Para obter os itens de linha da fatura especificada:

Chame o método ById para obter uma interface para operações de fatura para a fatura especificada.
Chame o método Get ou GetAsync para recuperar o objeto de fatura.

O objeto invoice contém todas as informações da fatura especificada. O Provedor identifica a origem das informações detalhadas não faturadas (por exemplo, OneTime). O InvoiceLineItemType especifica o tipo (por exemplo, UsageLineItem).

O código de exemplo a seguir usa um loop foreach para processar a coleção InvoiceLineItems . Uma coleção separada de itens de linha é recuperada para cada InvoiceLineItemType.

Para obter uma coleção de itens de linha que correspondem a uma instância de InvoiceDetail :

Passe BillingProvider e InvoiceLineItemType da instância para o método By.
Chame o método Get ou GetAsync para recuperar os itens de linha associados.
Crie um enumerador para percorrer a coleção, conforme mostrado no exemplo a seguir.

// IAggregatePartner partnerOperations;
// 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("unbilled").By("onetime", "usagelineitems", curencyCode, period, pageMaxSizeReconLineItems).Get();

var fetchNext = true;

ConsoleKeyInfo keyInfo;

var itemNumber = 1;
while (fetchNext)
{
    Console.Out.WriteLine("\tLine 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("unbilled").By("onetime", "usagelineitems", curencyCode, period, pageMaxSizeReconLineItems).Seek(seekBasedResourceCollection.ContinuationToken, SeekOperation.Next);
        }
    }
}

Para um exemplo semelhante, consulte:

Exemplo: Aplicativo de teste de console
Projeto: Exemplos de SDK do Partner Center
Classe: GetUnBilledConsumptionReconLineItemsPaging.cs

Solicitação REST

Sintaxe da solicitação

Você pode usar as seguintes sintaxes para sua solicitação REST, dependendo do seu caso de uso. Para obter mais informações, consulte as descrições de cada sintaxe.

Método	URI da solicitação	Descrição do caso de uso da sintaxe
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period} HTTP/1.1	Use essa sintaxe para retornar uma lista completa de cada item de linha para a fatura especificada.
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period}&size={size} HTTP/1.1	Use essa sintaxe para faturas grandes. Use essa sintaxe com um tamanho especificado e deslocamento baseado em 0 para retornar uma lista paginada de itens de linha.
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period}&size={size}&seekOperation=Next	Use essa sintaxe para obter a próxima página de itens de linha de reconciliação usando `seekOperation = "Next"`o .

Parâmetros do URI

Use o URI e os parâmetros de consulta a seguir ao criar a solicitação.

Nome	Digitar	Obrigatória	Descrição
provedor	string	Yes	O provedor: "OneTime".
invoice-line-item-type	string	Yes	O tipo de detalhe da fatura: "UsageLineItems", "UsageLineItems".
currencyCode	string	Yes	O código de moeda para os itens de linha não faturados.
period	string	Yes	O período para recon não faturado (por exemplo: atual, anterior). Suponha que você precise consultar seus dados de uso não faturados do ciclo de faturamento (01/01/2020 – 31/01/2020) em janeiro, escolha período como "Atual", ou seja , "Anterior".
tamanho	número	Não	O número máximo de itens a serem devolvidos. O tamanho padrão é 2000.
seekOperation	string	Não	Defina `seekOperation=Next` para obter a próxima página de itens de linha de reconciliação.

Cabeçalhos da solicitação

Para obter mais informações, confira Cabeçalhos REST do Partner Center.

Corpo da solicitação

Nenhum.

Resposta REST

Se for bem-sucedida, a resposta conterá a coleção de detalhes do item de linha.

Para o item de linha ChargeType, o valor Compra é mapeado para Novo e o valor Reembolso é mapeado para Cancelar.

Códigos de êxito e de erro de resposta

Cada resposta vem com um código de status HTTP que indica sucesso ou falha e outras informações de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e mais parâmetros. Para obter a lista completa, confira Códigos de erro REST do Partner Center.

Exemplos de solicitação-resposta

Exemplo de solicitação-resposta 1

Os detalhes a seguir se aplicam a este exemplo:

Provedor: OneTime
InvoiceLineItemType: UsageLineItems
Período: Anterior

Exemplo de solicitação 1

GET https://api.partnercenter.microsoft.com/v1//invoices/unbilled/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