Obter o resumo dos custos de serviço de um clienteGet a customer's service costs summary

Aplica-se a:Applies to:

  • Partner CenterPartner Center

Obtém os custos de serviço de um cliente para o período de cobrança especificado.Gets a customer's service costs for the specified billing period.

Pré-requisitosPrerequisites

  • Credenciais, conforme descrito em Autenticação do Partner Center.Credentials as described in Partner Center authentication. Este cenário dá suporte à autenticação com credenciais de aplicativo + usuário.This scenario supports authentication with App+User credentials.

  • Uma ID do cliente (customer-tenant-id).A customer ID (customer-tenant-id). Se você não souber a ID do cliente, poderá procurar no painel do Partner Center.If you don't know the customer's ID, you can look it up in the Partner Center dashboard. Selecione CSP no menu do Partner Center e, em seguida, Clientes.Select CSP from the Partner Center menu, followed by Customers. Selecione o cliente na lista de clientes e selecione Conta.Select the customer from the customer list, then select Account. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente.On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. A ID da Microsoft é igual à ID do cliente (customer-tenant-id).The Microsoft ID is the same as the customer ID (customer-tenant-id).

  • Um indicador de período de cobrança ( mostrecent ).A billing period indicator (mostrecent).

C#C#

Para recuperar um resumo de custos de serviço para o cliente especificado:To retrieve a service costs summary for the specified customer:

  1. Chame o método IAggregatePartner. Customers. ById com a ID do cliente para identificar o cliente.Call the IAggregatePartner.Customers.ById method with the customer ID to identify the customer.

  2. Use a propriedade de custo para obter uma interface para as operações de coleta de custos do atendimento ao cliente.Use the ServiceCosts property to get an interface to customer service costs collection operations.

  3. Chame o método ByBillingPeriod com um membro da enumeração ServiceCostsBillingPeriod para retornar um IServiceCostsCollection.Call the ByBillingPeriod method with a member of the ServiceCostsBillingPeriod enumeration to return an IServiceCostsCollection.

  4. Use o método IServiceCostsCollection. Summary. Get ou getasync para obter o resumo dos custos de serviço do cliente.Use the IServiceCostsCollection.Summary.Get or GetAsync method to get the customer's service costs summary.

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

var serviceCostsSummary = partnerOperations.Customers.ById(selectedCustomerId).ServiceCosts.ByBillingPeriod(ServiceCostsBillingPeriod.MostRecent).Summary.Get();

Solicitação RESTREST request

Sintaxe da solicitaçãoRequest syntax

MétodoMethod URI da solicitaçãoRequest URI
GETGET {baseURL}/v1/Customers/{Customer-ID}/servicecosts/{billing-period} http/1.1{baseURL}/v1/customers/{customer-id}/servicecosts/{billing-period} HTTP/1.1

Parâmetros do URIURI parameters

Use os seguintes parâmetros de caminho para identificar o cliente e o período de cobrança.Use the following path parameters to identify the customer and the billing period.

NomeName TipoType ObrigatórioRequired DescriçãoDescription
id do clientecustomer-id guidguid SimYes Uma ID de cliente formatada pelo GUID que identifica o cliente.A GUID formatted customer ID that identifies the customer.
período de cobrançabilling-period stringstring SimYes Um indicador que representa o período de cobrança.An indicator that represents the billing period. O único valor suportado é MostRecent.The only supported value is MostRecent. O caso da cadeia de caracteres não importa.The case of the string does not matter.

Cabeçalhos de solicitaçãoRequest headers

Para obter mais informações, confira Cabeçalhos REST do Partner Center.For more information, see Partner Center REST headers.

Corpo da solicitaçãoRequest body

nenhuma.None.

Exemplo de solicitaçãoRequest example

GET https://api.partnercenter.microsoft.com/v1/customers/65726577-c208-40fd-9735-8c85ac9cac68/servicecosts/mostrecent HTTP/1.1
Authorization: Bearer <authorization token>
Accept: application/json
MS-RequestId: e6a3b6b2-230a-4813-999d-57f883b60d38
MS-CorrelationId: a687bc47-8d08-4b78-aff6-5a59aa2055c2
X-Locale: en-US
Host: api.partnercenter.microsoft.com

Resposta RESTREST response

Se for bem-sucedido, o corpo da resposta conterá um recurso ServiceCostsSummary que fornece informações sobre os custos do serviço.If successful, the response body contains a ServiceCostsSummary resource that provides information about the service costs.

Códigos de êxito e de erro de respostaResponse success and error codes

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais.Use a network trace tool to read this code, error type, and additional parameters. Para obter a lista completa, confira Códigos de erro REST do Partner Center.For the full list, see Partner Center REST error codes.

Exemplo de respostaResponse example

HTTP/1.1 200 OK
Content-Length: 766
Content-Type: application/json; charset=utf-8
MS-CorrelationId: a687bc47-8d08-4b78-aff6-5a59aa2055c2
MS-RequestId: e6a3b6b2-230a-4813-999d-57f883b60d38
MS-CV: gPPoyNX1X0asAAcw.0
MS-ServerId: 101112202
Date: Fri, 02 Dec 2016 18: 54: 38 GMT

{
    "billingStartDate": "2015-12-12T00:00:00Z",
    "billingEndDate": "2016-01-11T00:00:00Z",
    "pretaxTotal": 17.22,
    "tax": 0.0,
    "afterTaxTotal": 17.22,
    "currencySymbol": "$",
    "customerId": "ae1d5b32-f9ff-4252-b2bf-40e21937a51a",
    "details":
     [
        {
            "invoiceType": "Recurring",
            "summary": {
                "billingStartDate": "2015-12-12T00:00:00Z",
                "billingEndDate": "2016-01-11T00:00:00Z",
                "pretaxTotal": 17.22,
                "tax": 0.0,
                "afterTaxTotal": 17.22,
                "currencyCode": "USD",
                "currencySymbol": "$",
                "customerId": "ae1d5b32-f9ff-4252-b2bf-40e21937a51a",
                "links": {},
                "attributes": {
                    "objectType": "ServiceCostsSummary"
                }
            }
        },
        {
            "invoiceType": "OneTime",
            "summary": {
                "billingStartDate": "2019-04-01T00:00:00Z",
                "billingEndDate": "2019-04-30T23:59:59.9999999Z",
                "pretaxTotal": 2,
                "tax": 0.2,
                "afterTaxTotal": 2.2,
                "currencyCode": "USD",
                "currencySymbol": "$",
                "customerId": "ae1d5b32-f9ff-4252-b2bf-40e21937a51a",
                "links": {},
                "attributes": {
                    "objectType": "ServiceCostsSummary"
                }
            }
        }
    ],
    "links": {
        "serviceCostLineItems": {
            "uri": "/customers/ae1d5b32-f9ff-4252-b2bf-40e21937a51a/servicecosts/MostRecent/lineitems",
            "method": "GET",
            "headers": []
        },
        "self": {
            "uri": "/customers/ae1d5b32-f9ff-4252-b2bf-40e21937a51a/servicecosts/MostRecent",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "ServiceCostsSummary"
    }
}