Благодарим вас за обратную связь.
Отправить обратную связь?Отчеты по оплате
Партнеры могут использовать следующие API-интерфейсы для оптового выставления счетов для создания отчетов по выставлению счетов , которые помогают им проверять точность использования и выделения ресурсов. API для оптового выставления счетов доступны на сайте developer.webex.com.
-
Согласование — показывает потребление ресурсов на уровне партнеров, клиентов или пользователей. Партнеры могут использовать эту настраиваемую информацию в платежном отчете для сверки ежемесячных счетов и выставлять счета своим клиентам и пользователям в соответствии с потреблением ресурсов.
-
На определенный момент времени — отображает текущее распределение пакетов на уровне каждого клиента или пользователя. Отчет «На определенный момент времени» содержит данные о количестве распределенных пакетов в реальном времени. Партнеры могут использовать эту информацию для проверки точности выделения ресурсов и обеспечения соответствия заказам клиентов.
Партнеры также могут создавать собственные отчеты по выставлению счетов для субпартнеров с помощью параметра SubPartnerOrgid.
Администраторам партнеров, отвечающим минимальным требованиям к доступу, доступны четыре API.
|
API для выставления счетов |
Назначение API |
Требования к доступу администратора партнера |
|---|---|---|
|
Создайте отчет об оптовых счетах |
Используется для создания платежного отчета. |
Чтение/запись |
|
Получите отчет об оптовом выставлении счетов |
Используется для получения сгенерированного платежного отчета для загрузки. |
Прочитайте |
|
Составьте отчеты об оптовых счетах |
Используется для составления списка отчетов об оплате, существующих для этого партнера. |
Прочитайте |
|
Удалить отчет об оптовых счетах |
Используется для удаления существующего платежного отчета. |
Чтение/запись |
Источник данных
Данные для отчетов по оплате берутся из данных о назначении пакетов и использовании, которые 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. Скоро мы удалим эти настройки. После их удаления вы можете запросить дополнительные столбцы только с помощью параметра Include. |
| 6 |
Нажмите кнопку «Выполнить», чтобы создать отчет. |
| 7 |
Скопируйте идентификатор отчета из выходных данных API. Вы можете использовать это значение в Get API для получения сгенерированного платежного отчета. |
Что делать дальше
Перейдите в раздел «Получите отчет об оптовых счетах», чтобы загрузить копию отчета.
Получите отчет об оптовом выставлении счетов
После создания отчета об оплате используйте этот API для получения конкретного платежного отчета. Отчет выводится по URL-адресу, по которому его можно загрузить в течение 30 минут после выполнения запроса GET.
| 1 |
На сайте developer.webex.com перейдите в раздел «Получите API для отчетов об оптовых счетах». |
| 2 |
Введите уникальное значение идентификатора отчета и нажмите кнопку «Выполнить». API выводит статус отчета. Выходные данные содержат параметр tempDownloadUrl, который предоставляет URL-адрес, с которого можно загрузить отчет. |
| 3 |
Скопируйте tempDownloadURL в браузер, чтобы получить доступ к отчету и загрузить его. |
Составьте отчеты об оптовых счетах
Используйте этот API для получения списка сгенерированных платежных отчетов для партнерской организации. Можно перечислить все существующие отчеты или ограничить список отчетами, которые соответствуют указанным параметрам, таким как расчетный период и тип оплаты (партнер, клиент, пользователь).
Если вы введете дополнительные параметры, API вернет только те отчеты, которые точно соответствуют указанным вами параметрам. Например, если вы укажете расчетный период, будут возвращены только отчеты, использующие этот расчетный период. Отчеты , относящиеся к данному периоду, но не совсем соответствующие датам, не возвращаются.
| 1 |
На сайте developer.webex.com перейдите в раздел API отчетов об оптовых счетах. |
| 2 |
В разделе Параметры запроса введите любые параметры поиска, которые хотите использовать (например, дату начала, дату окончания, тип, сортировку по). |
| 3 |
Нажмите кнопку «Выполнить». API выводит список отчетов вместе с уникальным идентификатором и статусом отчета (ЗАВЕРШЕН,IN_PROGRESS).
|
Что делать дальше
Запишите идентификатор всех отчетов, которые вы хотите загрузить . Перейдите в раздел «Получить отчет об оптовом выставлении счетов», чтобы загрузить отчет.
Удалите отчет об оптовых счетах
Используйте эту процедуру, чтобы удалить сгенерированный платежный отчет на основе идентификатора отчета. Вот несколько примеров, в которых вы можете захотеть удалить отчет:
-
Если вы хотите восстановить существующий отчет по счетам за сверку счетов, сначала необходимо удалить существующий отчет. После удаления существующего отчета можно создать новый отчет за этот период. Невозможно удалить отчет, если его создание завершилось неудачно или все еще продолжается.
Для отчета на определенный момент времени нет необходимости удалять существующий отчет, поскольку система не восстанавливает эти отчеты. В каждом отчете всегда отражаются данные на текущую временную метку.
-
Если вы отправите URL-адрес сгенерированного отчета не тому пользователю, вы можете удалить отчет, чтобы у него не было доступа к нему.
| 1 |
На сайте developer.webex.com перейдите в раздел «Удалить API отчетов об оптовых счетах». |
| 2 |
Введите идентификатор отчета и нажмите «Выполнить». |
Поля отчета по выставлению счетов
Отчеты по выставлению счетов содержат следующие поля:
|
Поле |
Описание |
Поддерживаемый тип отчета |
Поддерживаемая категория отчетов |
Обязательный или необязательный атрибут |
|---|---|---|---|---|
|
PARTNER_NAME |
Имя партнера |
PARTNER, CUSTOMER, USER |
Согласование на определенный момент |
Обязательное |
|
PARTNER_ORG_ID |
Уникальный идентификатор партнера |
PARTNER, CUSTOMER, USER |
Согласование на определенный момент |
Обязательное |
|
SUBSCRIPTION_ID |
Уникальный идентификатор подписки |
PARTNER, CUSTOMER, USER |
Согласование на определенный момент |
Обязательное |
|
CUSTOMER_GROUP_ID | Уникальный идентификатор группы, к которой принадлежит клиент. Если клиент перемещается между группами в течение расчетного периода, использование распределяется в зависимости от групп, к которым клиент принадлежал в течение этого периода. |
CUSTOMER, USER |
Согласование на определенный момент |
Опционально |
|
CUSTOMER_GROUP_NAME | Отображаемое имя группы клиентов. Если название группы изменилось в течение расчетного периода, используется последнее имя. |
CUSTOMER, USER |
Согласование на определенный момент |
Опционально |
|
CUSTOMER_ORG_ID |
Внутренний уникальный идентификатор клиента |
CUSTOMER, USER |
Согласование на определенный момент |
Обязательное |
|
CUSTOMER_EXTERNAL_ID |
Уникальный идентификатор клиента, предоставленный партнером |
CUSTOMER, USER |
Согласование на определенный момент |
Обязательное |
|
TYPE |
Тип пользователя или рабочего пространства |
CUSTOMER, USER |
На определенный момент времени |
Обязательное |
|
SUBSCRIBER_ID |
Уникальный идентификатор подписчика |
USER |
Согласование на определенный момент |
Обязательное |
|
USER_ID |
Идентификатор пользователя Webex подписчика |
USER |
Согласование на определенный момент |
Обязательное |
|
WORKSPACE_ID |
Уникальный идентификатор рабочего пространства |
USER |
Согласование на определенный момент |
Обязательное |
|
SERVICE_NAME |
Название сервиса (например,COMMON_AREA_CALLING,WEBEX_CALLING,WEBEX_SUITE,WEBEX_MEETINGS) |
PARTNER, CUSTOMER, USER |
Согласование на определенный момент |
Обязательное |
|
SKU |
Скайп для этой услуги |
PARTNER, CUSTOMER, USER |
Согласование на определенный момент |
Обязательное |
|
DESCRIPTION |
Описание услуги |
PARTNER, CUSTOMER, USER |
Согласование на определенный момент |
Обязательное |
|
CONSUMPTION_START_DATE |
Начало потребления услуги. Наряду со следующим полем это значение определяет период использования. |
PARTNER, CUSTOMER, USER |
Согласование |
Обязательное |
|
CONSUMPTION_END_DATE |
Прекращение потребления услуг. Как и предыдущее поле, это значение определяет период использования. |
PARTNER, CUSTOMER, USER |
Согласование |
Обязательное |
|
REPORT_DATE |
Дата и время создания отчета. |
CUSTOMER, USER |
На определенный момент времени |
Обязательное |
|
QUANTITY |
Представляет собой совокупное потребление пользователей в расчете на партнера, клиента или пользователя (в зависимости от отчета и уровня просмотра данных). Расчет: система рассчитывает количество пользователей в день на пропорциональной основе за этот день. Использование в течение целого дня = 1 Использование в течение полудня = 0,5 Затем суммируется общее количество дней за все дни расчетного периода, чтобы рассчитать общее количество пользователей за этот расчетный период. В отчетах на уровне клиентов и партнеров общие данные по всем пользователям суммируются, чтобы получить общее количество данных по данному клиенту или партнеру. На определенный момент времени: в отчете для клиентов указано распределение пакетов по каждому клиенту. В каждой строке указано общее количество определенного пакета, назначенного пользователям или рабочим пространствам в конкретной организации-заказчике. Если пакеты не распределены, в поле Количество отображается значение «0». В пользовательском отчете перечислены пакеты, назначенные пользователям или рабочим пространствам. В каждой строке указано количество, равное 1, что соответствует пользователю или рабочему пространству и их отдельному пакету или дополнению. Если пользователю или рабочему пространству выделено несколько пакетов или дополнений, в отчете отображается несколько записей, количество каждой из которых равно 1. |
PARTNER, CUSTOMER, USER |
Согласование на определенный момент |
Обязательное |
|
LOCATION_ID |
Уникальный идентификатор местоположения |
CUSTOMER, USER |
Согласование на определенный момент Отчет клиента на определенный момент времени не содержит идентификатора местоположения |
Опционально |
|
LICENSE_ID |
Идентификатор лицензии Это поле доступно только для оптовых упаковок В поле «Отчет о сверке» для лицензий, License_ID выданных до введения этого поля, поле «Отчет о сверке» пусто. В отчете о выставлении счетов отображается несколько строк для одного и того же оптового пакета, если он связан с разными LOCATION_ID комбинациями LICENSE_ID и. |
CUSTOMER, USER |
Согласование на определенный момент |
Опционально |
Выбор дополнительных столбцов изменяет порядок столбцов в отчетах о согласовании данных между клиентами и пользователями. Следующий порядок применим к партнерам, в подписке которых указаны только оптовые артикулы:
Отчет на уровне пользователя —PARTNER_NAME,,,,,,PARTNER_ORG_ID,,SUBSCRIPTION_ID,,CUSTOMER_GROUP_ID,,CUSTOMER_GROUP_NAME,,CUSTOMER_ORG_ID,,CUSTOMER_EXTERNAL_ID,,LOCATION_ID,,LICENSE_ID,,SUBSCRIBER_ID,,USER_ID,,WORKSPACE_ID,,SERVICE_NAME,,,,,,,,,,CONSUMPTION_START_DATE,,CONSUMPTION_END_DATE,,,,
Отчет об уровне клиента —PARTNER_NAME,,,,,,PARTNER_ORG_ID,,SUBSCRIPTION_ID,,CUSTOMER_GROUP_ID,,CUSTOMER_GROUP_NAME,,CUSTOMER_ORG_ID,,CUSTOMER_EXTERNAL_ID,,LOCATION_ID,,LICENSE_ID,,SERVICE_NAME,,,,,,,,,,CONSUMPTION_START_DATE,,CONSUMPTION_END_DATE,,,,
Предоставление пакета пользователю приводит к выставлению счетов Webex Wholesale, а при удалении назначения пакета оно прекращается.
В любой момент организация клиентов может входить только в одну группу клиентов. В настоящее время поддержка нескольких групп клиентов в каждой организации недоступна.
