Reconciliação de Faturamento

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 por parceiro, por cliente ou por usuário. Os parceiros podem usar essas informações para conciliar suas faturas mensais e cobrar seus clientes e usuários de acordo com seu consumo.

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 atendem aos requisitos mínimos de acesso.

API de cobrança

Objetivo da API

Requisito de acesso de administrador do parceiro

Criar um Relatório de Faturamento de Atacado

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

Ler / Escrever

Obtenha um relatório de faturamento de atacado

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

Ler

Listar relatórios de faturamento de atacado

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

Ler

Excluir um relatório de faturamento de atacado

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

Ler / Escrever

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. Todos os dias, o Webex rastreia o consumo de uso do dia anterior para todos os parceiros, clientes e usuários e agrega os dados para que eles 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 fatura os parceiros, consulte Faturamento do provedor de serviços.

Criar um Relatório de Faturamento de Atacado

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

Acesse a API Criar um Relatório de Faturamento por Atacado.

2

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

3

Digite o Tipo do relatório:

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

Clique em Executar para gerar o relatório.

5

Copie o relatório id 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

Acesse Obter um relatório de faturamento por atacado para baixar uma cópia do relatório.

Obtenha um relatório de faturamento 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 fica disponível para download por 30 minutos após a conclusão da solicitação GET.
1

Acesse a API Obter um Relatório de Faturamento por Atacado.

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 gera um relatório de status. 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 faturamento 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, 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 serão retornados.
1

Acesse a API do Relatório de Faturamento por Atacado da Lista

2

Em Parâmetros de consulta, insira quaisquer parâmetros de pesquisa que você deseja usar (por exemplo, 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 gera a lista de relatórios junto com o ID exclusivo do relatório e o status (CONCLUÍDO, EM_ANDAMENTO).

O que fazer em seguida

Anote o id para todos os relatórios que você deseja baixar. Acesse Obter um relatório de faturamento por atacado para baixar o relatório.

Excluir um relatório de faturamento de atacado

Use este procedimento para excluir um relatório de cobrança gerado com base no ID do relatório. Alguns exemplos de onde você pode querer excluir um relatório incluem:

  • Se você quiser regenerar um relatório de faturamento existente, primeiro você deve excluí-lo. Depois de excluir o relatório existente, você pode 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 o URL para a pessoa errada, você poderá excluir o relatório e ela não poderá acessá-lo.

1

Acesse a API Excluir Relatório de Faturamento por Atacado.

2

Digite o relatório Id.

3

Clique em Executar.

Campos do Relatório de Faturamento

Os relatórios de faturamento contêm os seguintes campos:

Campo

Informações adicionais

Aparece em relatórios do tipo

NOME DO PARCEIRO_

Nome do parceiro

PARCEIRO, CLIENTE, USUÁRIO

PARCEIRO_ORG_ID

Identificador de parceiro exclusivo

PARCEIRO, CLIENTE, USUÁRIO

ID DE ASSINATURA_

Identificador de assinatura exclusivo

PARCEIRO, CLIENTE, USUÁRIO

SERVIÇO_NOME

Nome do serviço

(por exemplo, CHAMADAS DE ÁREA COMUM__, CHAMADAS WEBEX_, SUÍTE WEBEX_, REUNIÕES WEBEX_)

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. Junto com o campo seguinte, este valor define o período de uso.

PARCEIRO, CLIENTE, USUÁRIO

CONSUMO_FIM_DATA

Fim do consumo do serviço. Junto com o campo anterior, este 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:

Eles calculam a quantidade diária para cada usuário proporcionalmente para aquele dia.

Uso por um dia inteiro = 1

Uso por meio dia = 0,5

Eles somam os totais diários de todos os dias dentro do período de cobrança para calcular a quantidade total para aquele usuário dentro daquele 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 aquele cliente ou parceiro.

PARCEIRO, CLIENTE, USUÁRIO

CLIENTE_ORGANIZAÇÃO_ID

Identificador Único do Cliente Interno

CLIENTE, USUÁRIO

CLIENTE_EXTERNO_ID

Identificador exclusivo do cliente fornecido por um parceiro

CLIENTE, USUÁRIO

ID DO ASSINANTE_

Identificador único para o assinante

USUÁRIO

ID do usuário._

ID do usuário Webex do assinante

USUÁRIO

ID DO ESPAÇO DE TRABALHO_

Identificador exclusivo do espaço de trabalho

USUÁRIO

LOCALIZAÇÃO_ID

Identificador de Localização Único

CLIENTE, USUÁRIO

LICENÇA_ID

Identificador de licença

Este campo é visível apenas para pacotes de atacado. O ID License_fica em branco para licenças atribuídas antes da introdução deste campo.

Um relatório de faturamento pode mostrar várias linhas para o mesmo pacote de atacado, com cada linha representando um único package/license Combinação de ID.

Se o campo LICENSE_ID estiver presente, cada linha representa uma licença exclusiva package/location/license Combinação de ID.

CLIENTE, USUÁRIO

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.