Благодарим вас за обратную связь.
Отправить обратную связь?Отчеты по выставлению счетов
Партнеры могут использовать следующие API для оптового выставления счетов, чтобы создавать отчеты о выставлении счетов, которые помогают им проверять точность использования и предоставления ресурсов. Доступ к API для оптовых платежей осуществляется через developer.webex.com.
-
Сверка — отображает данные об использовании на уровне партнера, клиента или пользователя. Партнеры могут использовать информацию из этого пользовательского отчета по выставлению счетов для сверки своих ежемесячных счетов, чтобы выставлять счета своим клиентам и пользователям в соответствии с их потреблением.
-
Отображает текущее распределение пакетов услуг на уровне клиента или пользователя. Отчет «На определенный момент времени» предоставляет данные о количестве выделенных пакетов в режиме реального времени. Партнеры могут использовать эту информацию для проверки точности предоставления услуг и обеспечения соответствия заказам клиентов.
Партнеры также могут создавать пользовательские отчеты по выставлению счетов для субпартнеров, используя параметр subPartnerOrgId.
Администраторам-партнерам, отвечающим минимальным требованиям к доступу, доступны четыре API.
|
API для выставления счетов |
Назначение API |
Требования к административным правам партнера |
|---|---|---|
|
Создать отчет по оптовым продажам |
Используется для формирования отчета по выставлению счетов. |
Read/write |
|
Получите отчет по оптовым продажам |
Используется для получения сгенерированного отчета о выставлении счетов для скачивания. |
Прочитать |
|
Отчеты по оптовым продажам |
Используется для отображения существующих отчетов по выставлению счетов для данного партнера. |
Прочитать |
|
Удаление отчета по оптовым продажам |
Используется для удаления существующего отчета по выставлению счетов. |
Read/write |
Источник данных
Данные для отчетов по выставлению счетов берутся из назначений пакетов и данных об использовании, которые Webex отслеживает для каждого партнера. Webex ежедневно собирает данные о пакетах услуг клиентов и пользователей для формирования ежемесячного счета-фактуры для партнера. API для выставления счетов используют эти данные, позволяя администраторам партнеров создавать пользовательские отчеты. Эти отчеты помогают партнерам сверять данные об использовании ресурсов, указанные в ежемесячном счете, на уровне партнеров, клиентов и пользователей.
Более подробную информацию о том, как Webex выставляет счета партнерам, см. в разделе Выставление счетов поставщику услуг.
Создать отчет по оптовым продажам
| 1 |
На сайте developer.webex.comперейдите в Создать API для оптовых счетов. |
| 2 |
Выберите одну из следующих категорий отчетов:
Если вы хотите создать отчет о сверке, ничего менять не нужно, поскольку сверка выбрана по умолчанию, поэтому вы можете перейти к следующему шагу. Если вы хотите создать отчет по отдельным моментам времени, измените параметр на «Отчет по отдельным моментам времени». |
| 3 |
Введите billingStartDate и billingEndDate в формате, указанном в API. Вы можете ввести любую дату за последние пять лет, но не текущий день. Для отчета «На определенный момент времени» поля billingStartDate и billingEndDate не являются обязательными и игнорируются, если в них введены данные. В отчете всегда отражается текущее распределение пакетов услуг. |
| 4 |
Введите тип отчета:
|
| 5 |
В поле Включить введите дополнительные или необязательные столбцы, которые вы хотите видеть в отчетах. Каждый тип отчета имеет набор обязательных и набор необязательных атрибутов. Вы можете выбрать, какие из необязательных атрибутов отображать для каждого отчета. Если не указать необязательные атрибуты, в отчете отобразятся только обязательные атрибуты. Следующие столбцы представляют собой необязательные атрибуты, которые вы можете запросить для включения в отчет по клиентам и пользователям:
Чтобы отобразить эти атрибуты в отчете, необходимо одновременно указать CUSTOMER_GROUP_ID и CUSTOMER_GROUP_NAME. При выборе необязательных столбцов порядок столбцов в отчетах по сверке клиентов и пользователей изменяется. Партнерам необходимо обновить свою интеграцию API, чтобы она поддерживала новый формат CSV. Порядок столбцов в отчетах за определенный момент времени остается неизменным. В настоящее время существующие настройки функций имеют приоритет над параметром Include при определении порядка столбцов. Например, если для клиента включена определенная настройка функции, то столбец с этой функцией будет отображаться в соответствии со старым форматом отчета, даже если вы добавите его в параметре «Включить». Вскоре мы удалим эти настройки. После их удаления запрашивать необязательные столбцы можно только через параметр Include. |
| 6 |
Нажмите Выполнить, чтобы сгенерировать отчет. |
| 7 |
Скопируйте идентификатор отчета из выходных данных API. Вы можете использовать это значение с API Get для получения сгенерированного отчета о выставлении счетов. |
Дальнейшие действия
Перейдите в раздел Получить отчет по оптовым продажам, чтобы загрузить копию отчета.
Получите отчет по оптовым продажам
После формирования отчета по выставлению счетов используйте этот API для получения конкретного отчета по выставлению счетов. Отчет выводится по URL-адресу, где он доступен для скачивания в течение 30 минут после завершения GET-запроса.
| 1 |
С сайта developer.webex.comперейдите по ссылке Получить API отчета по оптовым платежам. |
| 2 |
Введите уникальное id значение для отчета и нажмите Запустить. API выводит статус отчета. В выходные данные входит параметр tempDownloadURL, который предоставляет URL-адрес, с которого можно загрузить отчет. |
| 3 |
Скопируйте tempDownloadURL в браузер, чтобы получить доступ к отчету и загрузить его. |
Отчеты по оптовым продажам
Используйте этот API для получения списка сгенерированных отчетов по выставлению счетов для партнерской организации. Вы можете отобразить список всех существующих отчетов или ограничить список только теми отчетами, которые соответствуют указанным параметрам, таким как расчетный период и тип выставления счетов (Партнер, клиент, пользователь).
Если вы укажете необязательные параметры, API вернет только те отчеты, которые точно соответствуют указанным вами параметрам. Например, если вы укажете расчетный период, будут возвращены только отчеты, использующие этот конкретный расчетный период. Отчеты, поступившие в указанный период, но не точно совпадающие с датами, не возвращаются.
| 1 |
С сайта developer.webex.comперейдите к List Wholesale Billing Report API. |
| 2 |
В поле Параметры запросавведите любые параметры поиска, которые вы хотите использовать (например, startDate, endDate, Type, sortBy on). |
| 3 |
Нажмите кнопку Запуск. API выводит список отчетов вместе с уникальным идентификатором отчета ( id ) и статусом (COMPLETED, IN_( PROGRESS)).
|
Дальнейшие действия
Запишите идентификатор для всех отчетов, которые вы хотите загрузить. Перейдите по ссылке Получить отчет по оптовым продажам, чтобы загрузить отчет.
Удалить отчет по оптовым продажам
Используйте эту процедуру для удаления сгенерированного отчета по выставлению счетов на основе идентификатора отчета. Вот несколько примеров ситуаций, когда вам может потребоваться удалить отчет:
-
Чтобы восстановить существующий отчет по сверке счетов, необходимо сначала удалить этот отчет. После удаления существующего отчета вы можете создать новый отчет за этот период. Удалить отчет нельзя, если его создание не удалось или оно еще продолжается.
Для создания отчета на определенный момент времени нет необходимости удалять существующий отчет, поскольку система не генерирует их заново. В каждом отчете всегда отражены данные по состоянию на текущую дату.
-
Если вы отправите URL-адрес сгенерированного отчета не тому человеку, вы можете удалить отчет, и он не сможет получить к нему доступ.
| 1 |
С сайта developer.webex.comперейдите в Удалить API отчета по оптовым платежам. |
| 2 |
Введите идентификатор отчета и нажмите Запустить. |
Поля отчета о выставлении счетов
В отчетах по выставлению счетов содержатся следующие поля:
|
Поле |
Описание |
Поддерживаемые типы отчетов |
Поддерживаемая категория отчетов |
Обязательный или необязательный атрибут |
|---|---|---|---|---|
|
ПАРТНЕР_ИМЯ |
Имя партнера |
ПАРТНЕР, КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Примирение, на определенный момент времени |
Обязательно |
|
ПАРТНЕР_ОРГ_ИДЕНТИФИКАТОР |
Уникальный идентификатор партнера |
ПАРТНЕР, КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Примирение, на определенный момент времени |
Обязательно |
|
ПОДПИСКА_ID |
Уникальный идентификатор подписки |
ПАРТНЕР, КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Примирение, на определенный момент времени |
Обязательно |
|
ИДЕНТИФИКАТОР ГРУППЫ КЛИЕНТОВ__ | Уникальный идентификатор группы, к которой принадлежит клиент. Если клиент перемещается между группами в течение расчетного периода, использование услуг распределяется в зависимости от того, к каким группам клиент принадлежал в этот период. |
КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Примирение, на определенный момент времени |
Необязательно |
|
НАЗВАНИЕ ГРУППЫ КЛИЕНТОВ__ | Отобразить название группы клиентов. Если название группы изменилось в течение расчетного периода, используется последнее измененное название. |
КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Примирение, на определенный момент времени |
Необязательно |
|
ИДЕНТИФИКАТОР КЛИЕНТА_ОРГ_ |
Внутренний уникальный идентификатор клиента |
КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Примирение, на определенный момент времени |
Обязательно |
|
КЛИЕНТ_ВНЕШНИЙ_ИДЕНТИФИКАТОР |
Уникальный идентификатор клиента, предоставленный партнером. |
КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Примирение, на определенный момент времени |
Обязательно |
|
TYPE |
Тип пользователя или рабочей области |
КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Момент времени |
Обязательно |
|
ИДЕНТИФИКАТОР ПОДПИСЧИКА_ |
Уникальный идентификатор абонента |
USER |
Примирение, на определенный момент времени |
Обязательно |
|
USER_ID |
Идентификатор пользователя Webex подписчика |
USER |
Примирение, на определенный момент времени |
Обязательно |
|
РАБОЧАЯ ПРОСТРАНСТВО_ID |
Уникальный идентификатор рабочего пространства |
USER |
Примирение, на определенный момент времени |
Обязательно |
|
НАЗВАНИЕ СЛУЖБЫ_ |
Название услуги (например, ОБЩАЯ_ЗОНА_ЗВОНКИ, ЗВОНКИ WEBEX_ЗВОНКИ, WEBEX_ПАКЕТ, WEBEX_СОБРАНИЯ) |
ПАРТНЕР, КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Примирение, на определенный момент времени |
Обязательно |
|
SKU |
Артикул услуги |
ПАРТНЕР, КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Примирение, на определенный момент времени |
Обязательно |
|
ОПИСАНИЕ |
Описание услуги |
ПАРТНЕР, КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Примирение, на определенный момент времени |
Обязательно |
|
РАСХОД_НАЧАЛО_ДАТА |
Начало использования услуги. Наряду с указанным ниже полем, это значение определяет период использования. |
ПАРТНЕР, КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Сверка |
Обязательно |
|
ДАТА ПОТРЕБЛЕНИЯ_КОНЕЦ_ |
Окончание использования услуги. Наряду с предыдущим полем, это значение определяет период использования. |
ПАРТНЕР, КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Сверка |
Обязательно |
|
ОТЧЕТ_ДАТА |
Дата и время создания отчета. |
КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Момент времени |
Обязательно |
|
КОЛИЧЕСТВО |
Отражает совокупное потребление ресурсов пользователями по каждому партнеру, клиенту или пользователю (в зависимости от отчета и уровня просмотра данных). Расчет: Система рассчитывает количество потребления за день для каждого пользователя пропорционально отработанному времени. Использовать в течение всего дня = 1 Использование в течение половины дня = 0,5 Затем программа суммирует ежедневные суммы за все дни расчетного периода, чтобы рассчитать общую сумму для данного пользователя за этот расчетный период. В отчетах на уровне клиентов и партнеров итоговые суммы по всем пользователям суммируются для получения общей суммы по данному клиенту или партнеру. Момент времени: В отчете для клиентов указаны выделенные пакеты услуг для каждого клиента. Каждая строка отображает общее количество конкретного пакета, выделенного пользователям или рабочим местам в рамках конкретной клиентской организации. Если пакеты не выделены, в поле «Количество» отображается «0». В отчете для пользователей перечислены пакеты, назначенные пользователям или рабочим пространствам. В каждой строке указано значение 1, представляющее пользователя или рабочее пространство, а также их индивидуальный пакет или дополнение. Если пользователю или рабочему пространству назначено несколько пакетов или дополнений, то в отчете отображается несколько записей, каждая из которых содержит 1 единицу. |
ПАРТНЕР, КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Примирение, на определенный момент времени |
Обязательно |
|
МЕСТОПОЛОЖЕНИЕ_ID |
Уникальный идентификатор местоположения |
КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Примирение, на определенный момент времени В отчете о местоположении клиента на определенный момент времени отсутствует идентификатор местоположения. |
Необязательно |
|
ЛИЦЕНЗИЯ_ID |
Идентификатор лицензии Это поле отображается только для оптовых пакетов. В отчете о сверке поле License_ID остается пустым для лицензий, назначенных до введения этого поля. В отчете по выставлению счетов отображается несколько строк для одного и того же оптового пакета, если он связан с различными комбинациями идентификаторов LOCATION_ID и LICENSE_ID. |
КЛИЕНТ, ПОЛЬЗОВАТЕЛЬ |
Примирение, на определенный момент времени |
Необязательно |
Выбор необязательных столбцов изменяет порядок столбцов в отчетах по сверке данных о клиентах и пользователях. Следующий порядок применяется к партнерам, в подписке которых есть только оптовые товары (SKU):
Отчет на уровне пользователя — ПАРТНЕР_ИМЯ, ПАРТНЕР_ОРГАНИЗАЦИЯ_ИДЕНТИФИКАТОР, ПОДПИСКА_ИДЕНТИФИКАТОР, КЛИЕНТ_ГРУППА_ИДЕНТИФИКАТОР, КЛИЕНТ_ГРУППА_ИМЯ, КЛИЕНТ_ОРГАНИЗАЦИЯ_ИДЕНТИФИКАТОР, КЛИЕНТ_ВНЕШНИЙ_ИДЕНТИФИКАТОР, МЕСТОПОЛОЖЕНИЕ_ИДЕНТИФИКАТОР, ЛИЦЕНЗИЯ_ИДЕНТИФИКАТОР, ПОДПИСЧИК_ИДЕНТИФИКАТОР, ПОЛЬЗОВАТЕЛЬ_ИДЕНТИФИКАТОР, РАБОЧАЯ ПРОСТРАНСТВО_ИДЕНТИФИКАТОР, СЕРВИС_НАЗВАНИЕ, SKU, ОПИСАНИЕ, ПОТРЕБЛЕНИЕ_НАЧАЛО_ДАТА, ПОТРЕБЛЕНИЕ_КОНЕЦ_ДАТА, КОЛИЧЕСТВО
Отчет на уровне клиента — НАИМЕНОВАНИЕ ПАРТНЕРА_, ИДЕНТИФИКАТОР ОРГАНИЗАЦИИ__, ИДЕНТИФИКАТОР ПОДПИСКИ_, ИДЕНТИФИКАТОР ГРУППЫ КЛИЕНТА__, НАИМЕНОВАНИЕ ГРУППЫ КЛИЕНТА__, ИДЕНТИФИКАТОР ОРГАНИЗАЦИИ КЛИЕНТА_], ИДЕНТИФИКАТОР ВНЕШНЕГО КЛИЕНТА_, ИДЕНТИФИКАТОР МЕСТОПОЛОЖЕНИЯ__, ИДЕНТИФИКАТОР ЛИЦЕНЗИИ__, НАИМЕНОВАНИЕ УСЛУГИ_, АРТИКУЛ [_, ОПИСАНИЕ, ДАТА НАЧАЛА ПОТРЕБЛЕНИЯ__, ДАТА ОКОНЧАНИЯ ПОТРЕБЛЕНИЯ_, КОЛИЧЕСТВО
Предоставление пользователю пакета услуг запускает выставление счетов Webex Wholesale, а удаление назначения пакета услуг останавливает этот процесс.
Клиентская организация может одновременно принадлежать только к одной клиентской группе. В настоящее время поддержка нескольких групп клиентов в рамках одной организации недоступна.
