Дякуємо за відгук.
Надіслати відгук?Виставкові звіти
Партнери можуть використовувати наведені нижче 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. Порядок стовпців звітів про точку часу залишається незмінним. Наразі існуючі параметри функції мають пріоритет над параметром «Включити» при визначенні порядку стовпців. Наприклад, якщо певний параметр функції увімкнено для клієнта, цей стовпець функції відображатиметься відповідно до старого формату звіту, навіть якщо ви додасте їх у параметрі Включити. Незабаром ми видалимо ці налаштування. Після їх видалення ви можете запросити додаткові стовпці лише за допомогою параметра Включити. |
| 6 |
Натисніть кнопку Ви конати, щоб створити звіт. |
| 7 |
Скопіюйте іденти фікатор звіту з виводу API. Ви можете використовувати це значення за допомогою Get API для отримання згенерованого звіту про виставлення рахунків. |
Що робити далі
Перейдіть до розділу Отримати звіт про оп тову виставлення рахунків, щоб завантажити копію звіту.
Отримати звіт про оптові виставлення рахунків
Після створення звіту про виставлення рахунків використовуйте цей API для отримання конкретного звіту про виставлення рахунків. Звіт виводиться на URL-адресу, де він доступний для завантаження протягом 30 хвилин після завершення запиту GET.
| 1 |
На сайті developer.webex.com перейдіть до розділу Отримати звіт про оптові вистав лення рахунків. |
| 2 |
Введіть унікальне значення іденти фікатора звіту та натисніть кнопку Ви конати. API виводить стан звіту. Вихід включає параметр T empDownloadUr l, який надає URL-адресу, з якої можна завантажити звіт. |
| 3 |
Скопіюйте TempDownloadURL у браузер, щоб отримати доступ і завантажити звіт. |
Список звітів про оптові виставлення рахунків
Використовуйте цей API, щоб отримати список згенерованих звітів про виставлення рахунків для організації-партнера. Ви можете перерахувати всі існуючі звіти або обмежити список тими звітами, які відповідають вказаним параметрам, таким як ваш розрахунковий період та тип виставлення рахунків (партнер, клієнт, користувач).
Якщо ви вводите необов'язкові параметри, API повертає тільки ті звіти, які точно відповідають вказаним параметрам. Наприклад, якщо ви вкажете розрахунковий період, повертаються лише звіти, які використовують цей конкретний розрахунковий період. З віти, які належать до періоду, але не точно відповідають датам, не повертаються.
| 1 |
На сайті developer.webex.com перейдіть до розділу API звіту про оптові виставлення рахун ків. |
| 2 |
У розділі Параме три запиту введіть будь-які параметри пошуку, які ви хочете використовувати (наприклад, значення StartDate, EndDate, Type, SortBy увімкнено). |
| 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 |
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 |
Примирення, Точка в часі |
Необов'язковий |
Вибір необов'язкових стовпців змінює порядок стовпців звітів про узгодження клієнтів і користувачів. Наступне замовлення застосовується до партнерів, які мають лише оптові SKU у своїй підписці:
Звіт рівня користувача— PARTNER_NAMEPARTNER_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_IDSERVICE_NAME, SKU, ОПИС,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, SKU, ОПИС,CONSUMPTION_START_DATE,CONSUMPTION_END_DATE, КІЛЬКІСТЬ
Надання пакету користувачеві запускає виставлення рахунків Webex Wholesale, а видалення призначення пакета зупиняє його.
Організація-замовник може належати лише до однієї групи клієнтів у будь-який момент часу. Підтримка кількох груп клієнтів для кожної організації наразі недоступна.
