Obrigado pelos seus comentários.
Comentários?Relatórios de cobrança
Os parceiros podem usar as seguintes APIs de faturamento por atacado para gerar relatórios de faturamento que os ajudam a validar a precisão do uso e do provisionamento. As APIs de faturamento por atacado podem ser acessadas em developer.webex.com.
-
Reconciliação — exibe o consumo de uso por parceiro, por cliente ou por usuário. Os parceiros podem usar essas informações personalizadas do relatório de cobrança para reconciliar suas faturas mensais para que possam faturar seus clientes e usuários de acordo com o consumo de uso.
-
Point-In-Time — Exibe as alocações atuais de pacotes por cliente ou por usuário. O relatório Point-In-Time fornece uma contagem em tempo real das alocações de pacotes. Os parceiros podem usar essas informações para validar a precisão do provisionamento e garantir o alinhamento com os pedidos dos clientes.
Os parceiros também podem gerar relatórios de cobrança personalizados para subparceiros usando o parâmetro subpartnerOrgID.
Há quatro APIs disponíveis para administradores parceiros que atendam aos requisitos mínimos de acesso.
|
API de cobrança |
Objetivo da API |
Requisito de acesso do administrador do parceiro |
|---|---|---|
|
Crie um relatório de cobrança por atacado |
Usado para gerar um relatório de cobrança. |
Ler/escrever |
|
Obtenha um relatório de cobrança por atacado |
Usado para obter um relatório de cobrança gerado para download. |
Leia |
|
Listar relatórios de cobrança por atacado |
Usado para listar os relatórios de cobrança existentes para esse parceiro. |
Leia |
|
Excluir um relatório de cobrança por atacado |
Usado para excluir um relatório de cobrança existente. |
Ler/escrever |
Fonte de dados
Os dados dos relatórios de cobrança são extraídos das atribuições de pacotes e dos dados de uso que o Webex rastreia para cada parceiro. O Webex agrega os dados do pacote do cliente e do usuário diariamente para gerar a fatura mensal do parceiro. As APIs de cobrança usam esses dados, permitindo que os administradores parceiros gerem relatórios personalizados. Esses relatórios ajudam os parceiros a conciliar o consumo de uso de sua fatura mensal nos níveis de parceiro, cliente e usuário.
Para obter informações mais detalhadas sobre como a Webex fatura os parceiros, consulte Cobrança do provedor de serviços.
Crie um relatório de cobrança de atacado
| 1 |
Em developer.webex.com, acesse Criar uma API de relatório de faturamento por atacado. |
| 2 |
Selecione qualquer uma das seguintes categorias de relatório:
Se você quiser gerar um relatório de reconciliação, não há necessidade de alterar nada porque a reconciliação é selecionada por padrão, então você pode prosseguir para a próxima etapa. Se você quiser gerar um relatório Point-In-Time, altere a seleção para Point-In-Time. |
| 3 |
Insira BillingStartDate e BillingEndDate no formato que a API especifica. Você pode inserir qualquer data dos últimos cinco anos, mas não o dia atual. Para o relatório Point-In-Time, os campos BillingStartDate e BillingEndDate não são obrigatórios e são ignorados se inseridos. O relatório sempre reflete as alocações de pacotes atuais. |
| 4 |
Insira o tipo de relatório:
|
| 5 |
No campo Incluir, insira as colunas adicionais ou opcionais que você deseja ver nos relatórios. Cada tipo de relatório tem um conjunto de atributos obrigatórios e um conjunto de atributos opcionais. Você pode decidir quais atributos opcionais serão exibidos para cada relatório. Se você não incluir os atributos opcionais, o relatório exibirá somente os atributos obrigatórios. As colunas a seguir são os atributos opcionais que você pode solicitar para incluir no relatório Cliente e Usuário:
Você deve incluir CUSTOMER_GROUP_ID e CUSTOMER_GROUP_NAME em conjunto se quiser ver esses atributos em seu relatório. Quando você seleciona colunas opcionais, a ordem das colunas nos relatórios de reconciliação de clientes e usuários muda. Os parceiros devem atualizar sua integração de API para aceitar o novo formato csv. A ordem das colunas dos relatórios Point-In-Time permanece inalterada. Atualmente, as configurações de recursos existentes têm precedência sobre o parâmetro Include ao determinar a ordem das colunas. Por exemplo, se uma configuração de recurso específica estiver habilitada para um cliente, essa coluna de recurso aparecerá de acordo com o formato de relatório antigo, mesmo que você a adicione no parâmetro Incluir. Removeremos essas configurações em breve. Depois de removidas, você pode solicitar as colunas opcionais somente por meio do parâmetro Include. |
| 6 |
Clique em Executar para gerar o relatório. |
| 7 |
Copie o ID do relatório da saída da API. Você pode usar esse valor com a API Get para obter o relatório de faturamento gerado. |
O que fazer a seguir
Acesse a seção Obter um relatório de cobrança por atacado para baixar uma cópia do relatório.
Obtenha um relatório de cobrança de atacado
Depois que um relatório de cobrança for gerado, use essa API para obter um relatório de cobrança específico. O relatório é enviado para uma URL onde fica disponível para download por 30 minutos após a conclusão da solicitação GET.
| 1 |
Em developer.webex.com, acesse a API Obter um relatório de faturamento por atacado. |
| 2 |
Insira o valor de ID exclusivo para o relatório e clique em Executar. A API gera o status do relatório. A saída inclui o parâmetro tempDownloadUrl, que fornece uma URL a partir da qual você pode baixar o relatório. |
| 3 |
Copie o tempDownloadUrl em um navegador para acessar e baixar o relatório. |
Listar relatórios de cobrança por atacado
Use essa API para obter uma lista de relatórios de faturamento gerados para a organização parceira. Você pode listar todos os relatórios existentes ou limitar a lista aos relatórios que atendem aos parâmetros especificados, como período de cobrança e tipo de cobrança (parceiro, cliente, usuário).
Se você inserir parâmetros opcionais, a API retornará somente os relatórios que correspondam exatamente aos parâmetros que você especificar. Por exemplo, se você especificar um período de cobrança, somente os relatórios que usam esse período de cobrança específico serão retornados. Os relatórios que estão dentro do período, mas que não correspondem exatamente às datas, não são retornados.
| 1 |
Em developer.webex.com, acesse a API List Wholesale Billing Report. |
| 2 |
Em Parâmetros de consulta, insira qualquer parâmetro de pesquisa que você queira usar (por exemplo, StartDate, EndDate, Type, SortBy on). |
| 3 |
Clique em Executar. A API exibe a lista de relatórios junto com o ID e o status exclusivos do relatório (CONCLUÍDO,IN_PROGRESS).
|
O que fazer a seguir
Registre o ID de todos os relatórios que você deseja baixar. Acesse Obter um relatório de cobrança por atacado para fazer o download do relatório.
Excluir um relatório de cobrança de atacado
Use esse procedimento para excluir um relatório de cobrança gerado com base na ID do relatório. Alguns exemplos em que você pode querer excluir um relatório incluem:
-
Se você quiser regenerar um relatório de cobrança de reconciliação existente, primeiro exclua o relatório existente. Depois de excluir o relatório existente, você pode criar um novo relatório para esse período. Você não pode excluir um relatório se sua geração falhar ou se ainda estiver em andamento.
Para um relatório Point-In-Time, você não precisa excluir um relatório existente, pois o sistema não regenera esses relatórios. Cada relatório sempre reflete os dados da data e hora atual.
-
Se você enviar um URL de relatório gerado para a pessoa errada, poderá excluir o relatório para que ela não possa acessá-lo.
| 1 |
Em developer.webex.com, acesse a API Excluir relatório de faturamento por atacado. |
| 2 |
Insira o ID do relatório e clique em Executar. |
Campos do relatório de cobrança
Os relatórios de cobrança contêm os seguintes campos:
|
Campo |
Descrição |
Tipo de relatório suportado |
Categoria de relatório suportada |
Atributo obrigatório ou opcional |
|---|---|---|---|---|
|
PARTNER_NAME |
Nome do parceiro |
PARTNER, CUSTOMER, USER |
Reconciliação, point-in-time |
Obrigatório |
|
PARTNER_ORG_ID |
Identificador de parceiro exclusivo |
PARTNER, CUSTOMER, USER |
Reconciliação, point-in-time |
Obrigatório |
|
SUBSCRIPTION_ID |
Identificador de assinatura exclusivo |
PARTNER, CUSTOMER, USER |
Reconciliação, point-in-time |
Obrigatório |
|
CUSTOMER_GROUP_ID | O identificador exclusivo do grupo ao qual o cliente pertence. Se o cliente for transferido entre grupos durante o período de cobrança, o uso será dividido com base nos grupos aos quais o cliente pertenceu durante esse período. |
CUSTOMER, USER |
Reconciliação, point-in-time |
Opcional |
|
CUSTOMER_GROUP_NAME | Nome de exibição do grupo de clientes. Se o nome do grupo for alterado durante o período de cobrança, o nome mais recente será usado. |
CUSTOMER, USER |
Reconciliação, point-in-time |
Opcional |
|
CUSTOMER_ORG_ID |
Identificador exclusivo interno do cliente |
CUSTOMER, USER |
Reconciliação, point-in-time |
Obrigatório |
|
CUSTOMER_EXTERNAL_ID |
Identificador exclusivo do cliente, conforme fornecido por um parceiro |
CUSTOMER, USER |
Reconciliação, point-in-time |
Obrigatório |
|
TYPE |
Tipo de usuário ou espaço de trabalho |
CUSTOMER, USER |
Point-in-time |
Obrigatório |
|
SUBSCRIBER_ID |
Identificador exclusivo para o assinante |
USER |
Reconciliação, point-in-time |
Obrigatório |
|
USER_ID |
O ID de usuário Webex do assinante |
USER |
Reconciliação, point-in-time |
Obrigatório |
|
WORKSPACE_ID |
Identificador exclusivo do espaço de trabalho |
USER |
Reconciliação, point-in-time |
Obrigatório |
|
SERVICE_NAME |
Nome do serviço (por exemplo,,COMMON_AREA_CALLING, WEBEX_CALLINGWEBEX_SUITE,WEBEX_MEETINGS) |
PARTNER, CUSTOMER, USER |
Reconciliação, point-in-time |
Obrigatório |
|
SKU |
Sku para o serviço |
PARTNER, CUSTOMER, USER |
Reconciliação, point-in-time |
Obrigatório |
|
DESCRIPTION |
Descrição do serviço |
PARTNER, CUSTOMER, USER |
Reconciliação, point-in-time |
Obrigatório |
|
CONSUMPTION_START_DATE |
Início do consumo do serviço. Junto com o campo a seguir, esse valor define o período de uso. |
PARTNER, CUSTOMER, USER |
Reconciliação |
Obrigatório |
|
CONSUMPTION_END_DATE |
Fim do consumo do serviço. Junto com o campo anterior, esse valor define o período de consumo de uso. |
PARTNER, CUSTOMER, USER |
Reconciliação |
Obrigatório |
|
REPORT_DATE |
A data e a hora em que o relatório é gerado. |
CUSTOMER, USER |
Point-in-time |
Obrigatório |
|
QUANTITY |
Representa o consumo agregado de uso do usuário por parceiro, por cliente ou por usuário (dependendo do relatório e do nível em que você está visualizando os dados). Cálculo: o sistema calcula a quantidade por dia para cada usuário de forma rateada para esse dia. Uso por um dia inteiro = 1 Uso por meio dia = 0,5 Em seguida, ele soma os totais por dia de todos os dias do período de cobrança para calcular a quantidade total desse usuário nesse período de cobrança. Para relatórios em nível de cliente e parceiro, os totais de todos os usuários são agregados para fornecer uma quantidade total para esse cliente ou parceiro. Point-In-Time: O relatório do cliente lista as alocações de pacotes por cliente. Cada linha representa a quantidade total de um pacote específico atribuído a usuários ou espaços de trabalho em uma organização específica do cliente. A Quantidade mostra “0” se não houver pacotes alocados. O relatório do usuário lista os pacotes atribuídos aos usuários ou espaços de trabalho. Cada linha mostra uma quantidade de 1, representando um usuário ou espaço de trabalho e seu pacote ou complemento individual. Se vários pacotes ou complementos forem alocados para um usuário ou espaço de trabalho, o relatório mostrará várias entradas, cada uma com uma quantidade de 1. |
PARTNER, CUSTOMER, USER |
Reconciliação, point-in-time |
Obrigatório |
|
LOCATION_ID |
Identificador de localização exclusivo |
CUSTOMER, USER |
Reconciliação, point-in-time O relatório Point-In-Time do cliente não inclui ID de localização |
Opcional |
|
LICENSE_ID |
Identificador de licença Esse campo é visível somente para pacotes de atacado Para o relatório de reconciliação, License_ID está em branco as licenças atribuídas antes da introdução desse campo. O relatório de cobrança mostra várias linhas para o mesmo pacote de atacado se ele estiver associado a diferentes combinações de e. LOCATION_ID LICENSE_ID |
CUSTOMER, USER |
Reconciliação, point-in-time |
Opcional |
A seleção de colunas opcionais modifica a ordem das colunas dos relatórios de reconciliação de clientes e usuários. A ordem a seguir se aplica a parceiros com apenas SKUs de atacado em sua assinatura:
Relatório de nível de usuário — PARTNER_NAME PARTNER_ORG_IDSUBSCRIPTION_ID,CUSTOMER_GROUP_ID,CUSTOMER_GROUP_NAME,CUSTOMER_ORG_ID,CUSTOMER_EXTERNAL_ID,LOCATION_ID,LICENSE_ID,SUBSCRIBER_ID,USER_ID, WORKSPACE_IDSERVICE_NAME, SKU, DESCRIÇÃO,, CONSUMPTION_START_DATECONSUMPTION_END_DATE, QUANTIDADE
Relatório de nível de cliente — PARTNER_NAME PARTNER_ORG_IDSUBSCRIPTION_ID,CUSTOMER_GROUP_ID,CUSTOMER_GROUP_NAME,CUSTOMER_ORG_ID,,CUSTOMER_EXTERNAL_ID,LOCATION_ID, LICENSE_IDSERVICE_NAME, SKU, DESCRIÇÃO,, CONSUMPTION_START_DATECONSUMPTION_END_DATE, QUANTIDADE
O provisionamento de um pacote para um usuário aciona o faturamento do Webex Wholesale, enquanto a remoção da atribuição do pacote o interrompe.
Uma organização de clientes só pode pertencer a um grupo de clientes em um determinado momento. O suporte para vários grupos de clientes por organização não está disponível no momento.
