Reconciliação de cobrança

Os administradores de parceiros podem usar as APIs de cobrança por atacado para gerar relatórios de cobrança personalizados que exibem o consumo de uso nos níveis por parceiro, por cliente ou por usuário. Os parceiros podem usar essas informações para reconciliar sua fatura mensal para que possam cobrar aos seus clientes e usuários de acordo com seu consumo de uso.

Os parceiros também podem gerar relatórios de cobrança personalizados para subparceiros usando o parâmetro subPartnerOrgId.

Existem quatro APIs que estão disponíveis para administradores de parceiros que atendem aos requisitos mínimos de acesso.

API de cobrança

Finalidade da API

Requisito de acesso do administrador do parceiro

Criar um relatório de cobrança de atacado

Usado para gerar um relatório de cobrança.

Leitura/Gravação

Obter um relatório de cobrança de atacado

Usado para obter um relatório de cobrança gerado para download.

Ler

Listar relatórios de cobrança de atacado

Usado para listar os relatórios de cobrança existentes para esse parceiro.

Ler

Excluir um relatório de cobrança de atacado

Usado para excluir um relatório de cobrança existente.

Leitura/Gravação

Fonte de dados

Os dados para os relatórios de Cobrança são extraídos dos dados de consumo de uso que o Webex rastreia para cada parceiro. A cada dia, o Webex rastreia o consumo de uso do dia anterior para todos os parceiros, clientes e usuários e agrega os dados para que possam ser usados para gerar a fatura mensal do parceiro. As APIs de cobrança aproveitam esses dados, permitindo que os administradores de parceiros gerem relatórios personalizados para que o parceiro possa 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 o Webex faz parceria com as faturas, consulte Cobrança do provedor de serviços.

Criar um relatório de cobrança de atacado

Use este procedimento para gerar um relatório de cobrança personalizado que você pode usar para reconciliar sua cobrança.
1

Vá para a API Criar um relatório de cobrança de varejo.

2

Insira o período de cobrança inserindo valores para o billingStartDate e o billingEndDate no formato especificado pela API. Você pode inserir qualquer data dos últimos cinco anos, mas não o dia atual.

3

Insira o Tipo de relatório:

  • PARCEIRO (este é o padrão) — Mostra o consumo de uso no nível do parceiro.
  • CLIENTE — Mostra o consumo total de uso dividido de acordo com o nível das organizações do cliente no parceiro.
  • USUÁRIO — Mostra o consumo total de uso discriminado de acordo com o nível das organizações do cliente e dos assinantes no parceiro.
4

Clique em Executar para gerar o relatório.

5

Copie a id do relatório da saída da API. Você pode usar esse valor com a API Get para obter o relatório de cobrança gerado.

O que fazer em seguida

Vá para Obter um relatório de cobrança de atacado para baixar uma cópia do relatório.

Obter um relatório de cobrança de atacado

Depois que um relatório de cobrança for gerado, use esta API para obter um relatório de cobrança específico. O relatório é enviado para uma URL onde está disponível para download por 30 minutos após a conclusão da solicitação GET.
1

Vá para a API Obter um relatório de cobrança de varejo.

2

Na linha GET , clique no botão id e insira o valor de id exclusivo para o relatório.

3

Clique em Executar.

4

A API emite o status do relatório. A saída inclui o parâmetro tempDownloadURL , que fornece uma URL da qual você pode baixar o relatório.

5

Copie o tempDownloadURL em um navegador para acessar e baixar o relatório.

Listar relatórios de cobrança de atacado

Use esta API para obter uma lista de relatórios de cobrança 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 seu período de cobrança e tipo de cobrança (parceiro, cliente, usuário).

Se você inserir parâmetros opcionais, a API retornará apenas os relatórios que correspondem exatamente aos parâmetros inseridos. Por exemplo, se você inserir um período de cobrança, apenas os relatórios que usam esse período de cobrança específico são retornados — relatórios que se enquadram no período, mas que não correspondem exatamente às datas não são retornados.
1

Ir para a lista de API do relatório de cobrança de atacado

2

Em Parâmetros de consulta, insira os parâmetros de pesquisa que você deseja usar (por exemplo, the startDate, endDate, Type, sortBy on). Para obter detalhes adicionais sobre esses parâmetros, consulte a Ajuda do desenvolvedor na API.

3

Clique em Executar.

A API fornece a lista de relatórios juntamente com a ID e o status exclusivos do relatório (CONCLUÍDO, EM_ANDAMENTO).

O que fazer em seguida

Faça um registro da ID de todos os relatórios que você deseja baixar. Vá para Obter um relatório de cobrança de atacado para baixar o relatório.

Excluir um relatório de cobrança de atacado

Use este 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 gerar novamente um relatório de cobrança existente, primeiro você deve excluir o relatório existente. Depois de excluir o relatório existente, você poderá criar um novo relatório para esse período. Observe que o requisito de exclusão não existe se o relatório falhar ou estiver em andamento.

  • Se um relatório for gerado e você enviar a URL para a pessoa errada, você poderá excluir o relatório e ela não poderá acessá-lo.

1

Vá para a API Excluir relatório de cobrança de atacado.

2

Insira a ID do relatório.

3

Clique em Executar.

Campos de relatório de cobrança

Os relatórios de cobrança contêm os seguintes campos:

Campo

Informações adicionais

Aparece em Relatórios deste tipo

NOME_DO PARCEIRO

Nome do parceiro

parceiro, cliente, usuário

ID_DA ORGANIZAÇÃO_DO PARCEIRO

Identificador exclusivo de parceiro

parceiro, cliente, usuário

ID_DE INSCRIÇÃO

Identificador exclusivo de assinatura

parceiro, cliente, usuário

NOME_DO SERVIÇO

Nome do serviço

(por exemplo, CHAMADAS DE_ÁREA COMUM_, WEBEX_CALLING, WEBEX_SUITE, WEBEX_MEETINGS)

parceiro, cliente, usuário

SKU

Sku para o serviço

parceiro, cliente, usuário

descrição

Descrição do serviço

parceiro, cliente, usuário

CONSUMO_INÍCIO_DATA

Início do consumo do serviço. Juntamente com o campo abaixo, esse valor define o período de uso.

parceiro, cliente, usuário

DATA_FINAL_ DE CONSUMO

Fim do consumo do serviço. Juntamente com o campo acima, esse valor define o período de consumo de uso.

parceiro, cliente, usuário

quantidade

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:

Para cada utilizador, a quantidade diária é calculada numa base proporcional para esse dia. Por exemplo:

Uso por um dia inteiro = 1

Uso por meio dia = 0,5

Os totais diários de todos os dias do período de cobrança são somados para fornecer uma quantidade total para esse usuário dentro desse período de cobrança.

Para relatórios a 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.

parceiro, cliente, usuário

ID_DA ORGANIZAÇÃO_DO CLIENTE

Identificador exclusivo interno do cliente

cliente, usuário

_ID EXTERNA_DO CLIENTE

Identificador exclusivo do cliente, conforme fornecido por um parceiro

cliente, usuário

ID_DO ASSINANTE

Identificador exclusivo para o assinante

USUÁRIO

ID do usuário._

A ID de usuário Webex do assinante

USUÁRIO

ESPAÇO DE TRABALHO_ID

Identificador exclusivo de espaço de trabalho

USUÁRIO

ID_ DE LOCALIZAÇÃO

Identificador de localização exclusivo

cliente, usuário

A cobrança do Webex Wholesale é acionada pelo provisionamento de um pacote para um usuário ou interrompida removendo a atribuição do pacote.