Сверка платежей

Администраторы партнеров могут использовать API-интерфейсы выставления счетов Wholesale для создания пользовательских отчетов о выставлении счетов, отображающих использование на уровне каждого партнера, клиента или пользователя. Партнеры могут использовать эту информацию для согласования своих ежемесячных счетов, чтобы иметь возможность выставлять счета своим клиентам и пользователям в зависимости от их использования.

Партнеры также могут создавать настраиваемые отчеты о платежах для субпартнеров с помощью параметра subPartnerOrgId.

Существует четыре API, доступных администраторам партнеров, которые соответствуют минимальным требованиям к доступу.

API для выставления счетов

Назначение API

Требование доступа администратора партнера

Создание отчета о платежах Wholesale

Используется для создания отчета о платежах.

Чтение/запись

Получение отчета о платежах Wholesale

Используется для получения созданного отчета о платежах для скачивания.

Прочитанные

Отображение отчетов о платежах Wholesale

Используется для отображения отчетов о платежах, существующих для этого партнера.

Прочитанные

Удаление отчета о платежах Wholesale

Используется для удаления существующего отчета о платежах.

Чтение/запись

Источник данных

Данные для отчетов о платежах извлекаются из данных об использовании, отслеживаемых службой Webex для каждого партнера. Каждый день Webex отслеживает использование за предыдущий день для всех партнеров, клиентов и пользователей и агрегирует данные, чтобы их можно было использовать для создания ежемесячного счета партнера. Эти данные используются API для выставления счетов, что позволяет администраторам партнера создавать пользовательские отчеты, чтобы партнер мог согласовать потребление использования из своего ежемесячного счета на уровне партнера, клиента и пользователя.

Дополнительную информацию о способах выставления счетов партнерами Webex см. в статье Выставление счетов поставщиком услуг.

Создание отчета о платежах Wholesale

Используйте эту процедуру для создания пользовательского отчета о платежах, который можно использовать для согласования платежей.
1

Перейдите в раздел "Создать API отчета о платежах Wholesale".

2

Введите период выставления счетов, введя значения для billingStartDate и billingEndDate в формате, указанном API. Можно ввести любую дату за последние пять лет, но не текущий день.

3

Введите тип отчета.

  • PARTNER (по умолчанию): отображает потребление использования на уровне партнера.
  • КЛИЕНТ. Отображает общее потребление использования с разбивкой по уровню клиентских организаций партнера.
  • ПОЛЬЗОВАТЕЛЬ. Отображает общее потребление использования с разбивкой по уровню клиентских организаций и подписчиков партнера.
4

Щелкните Запустить , чтобы создать отчет.

5

Скопируйте идентификатор отчета из вывода API. Для получения созданного отчета о платежах можно использовать это значение с помощью API Get.

Дальнейшие действия

Чтобы скачать копию отчета, перейдите в раздел Получить отчет о платежах Wholesale .

Получение отчета о платежах Wholesale

После создания отчета о платежах используйте этот API для получения конкретного отчета о платежах. Отчет выводится на URL-адрес, где он доступен для скачивания в течение 30 минут после завершения запроса GET.
1

Перейдите к API "Получить отчет о платежах Wholesale".

2

В строке GET щелкните кнопку id (Идентификатор) и введите уникальное значение идентификатора для отчета.

3

Нажмите кнопку Запуск.

4

Состояние отчета о выходе API. Выходные данные включают параметр tempDownloadURL , который предоставляет URL-адрес для скачивания отчета.

5

Чтобы получить доступ к отчету и скачать его, скопируйте tempDownloadURL в браузер.

Отображение отчетов о платежах Wholesale

Используйте этот API для получения списка созданных отчетов о платежах для партнерской организации. Можно отобразить все существующие отчеты или ограничить их до тех, которые соответствуют определенным параметрам, таким как период выставления счетов и тип выставления счетов (партнер, клиент, пользователь).

Если ввести необязательные параметры, API возвращает только те отчеты, которые точно соответствуют введенным параметрам. Например, при вводе периода выставления счетов будут возвращены только отчеты, в которых используется определенный период выставления счетов. Отчеты, которые относятся к периоду, но не соответствуют датам, не будут возвращены.
1

Перейти к списку API отчета о платежах Wholesale

2

В разделе Параметры запроса введите все необходимые параметры поиска (например, startDate, endDate, Type, sortBy on). Дополнительные сведения об этих параметрах см. в справке разработчика по API.

3

Нажмите кнопку Запуск.

API выводит список отчетов вместе с уникальным идентификатором и состоянием отчета (ЗАВЕРШЕНО, ВЫПОЛНЯЕТСЯ_).

Дальнейшие действия

Создайте запись идентификатора для всех отчетов, которые необходимо скачать. Чтобы скачать отчет, перейдите в раздел Получить отчет о платежах Wholesale .

Удаление отчета о платежах Wholesale

Используйте эту процедуру для удаления созданного отчета о платежах на основе идентификатора отчета. Ниже приведены несколько примеров удаления отчета.

  • Чтобы создать существующий отчет о платежах повторно, сначала необходимо удалить существующий отчет. После удаления существующего отчета можно создать новый отчет за этот период. Обратите внимание, что в случае сбоя или выполнения отчета требование удаления не существует.

  • Если отчет создается и вы отправляете URL другому пользователю, отчет можно удалить, и он не сможет получить к нему доступ.

1

Перейдите в раздел "Удалить API отчета о платежах Wholesale".

2

Введите идентификатор отчета.

3

Нажмите кнопку Запуск.

Поля отчета о платежах

Отчеты о платежах содержат следующие поля:

Поле

Дополнительная информация

Отображается в отчетах этого типа

ИМЯ_ПАРТНЕРА

Имя партнера

партнер, клиент, пользователь

ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ_ПАРТНЕРА

Уникальный идентификатор партнера

партнер, клиент, пользователь

ИДЕНТИФИКАТОР_ПОДПИСКИ

Уникальный идентификатор подписки

партнер, клиент, пользователь

НАЗВАНИЕ_СЛУЖБЫ

Название службы

(например, ВЫЗОВЫ В ЗОНАХ ОБЩЕГО ПОЛЬЗОВАНИЯ__ВЫЗОВОВ, WEBEX_CALLING, WEBEX_ПАКЕТ, WEBEX_MEETINGS)

партнер, клиент, пользователь

SKU

Sku для службы

партнер, клиент, пользователь

описание

Описание службы

партнер, клиент, пользователь

ДАТА_НАЧАЛА_ПОТРЕБЛЕНИЯ

Начало использования службы. Вместе с полем ниже это значение определяет период использования.

партнер, клиент, пользователь

_ДАТА ОКОНЧАНИЯ_ПОТРЕБЛЕНИЯ

Прекращение потребления услуг. Вместе с указанным выше полем это значение определяет период использования.

партнер, клиент, пользователь

количество

Представляет агрегированное значение использования пользователей для каждого партнера, каждого клиента или каждого пользователя (в зависимости от отчета и уровня просмотра данных).

Вычисление:

Для каждого пользователя количество за день рассчитывается на пропорциональной основе за этот день. Например:

Использование за полный день = 1

Использование в течение полудня = 0,5

Суммарные данные за каждый день в течение всего периода выставления счетов суммируются, чтобы указать общее количество для этого пользователя в течение этого периода выставления счетов.

Для отчетов на уровне клиента и партнера общие данные для всех пользователей агрегированы для предоставления общего количества для этого клиента или партнера.

партнер, клиент, пользователь

ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ_КЛИЕНТА

Уникальный идентификатор внутреннего клиента

клиент, пользователь

ИДЕНТИФИКАТОР_ВНЕШНЕГО_КЛИЕНТА

Уникальный идентификатор клиента, предоставленный партнером

клиент, пользователь

ИДЕНТИФИКАТОР_ПОДПИСЧИКА

Уникальный идентификатор для подписчика

USER

USER_ID

Идентификатор пользователя Webex подписчика

USER

ИДЕНТИФИКАТОР_РАБОЧЕГО ПРОСТРАНСТВА

Уникальный идентификатор рабочего пространства

USER

ИДЕНТИФИКАТОР_МЕСТОПОЛОЖЕНИЯ

Уникальный идентификатор местоположения

клиент, пользователь

Платежи Webex Wholesale инициируются путем подготовки пакета для пользователя или остановлены посредством удаления назначения пакета.