Дякуємо за відгук.
Надіслати відгук?Звіти про виставлення рахунків
Партнери можуть використовувати такі 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 |
У полі Включити введіть додаткові або необов’язкові стовпці, які ви хочете бачити у звітах. Кожен тип звіту має набір обов'язкових атрибутів та набір додаткових атрибутів. Ви можете вирішити, які з додаткових атрибутів відображати для кожного звіту. Якщо не вказати додаткові атрибути, у звіті відображатимуться лише обов'язкові атрибути. Наведені нижче стовпці – це додаткові атрибути, які можна запросити для включення до звіту «Клієнт» та «Користувач»:
Ви повинні включити разом ІДЕНТИФІКАТОР КЛІЄНТА_ГРУПИ_та НАЗВУ КЛІЄНТА_ГРУПИ_, якщо хочете побачити ці атрибути у своєму звіті. Коли ви вибираєте додаткові стовпці, порядок стовпців у звітах про звірку клієнтів і користувачів змінюється. Партнери повинні оновити свою інтеграцію API, щоб прийняти новий формат CSV. Порядок стовпців у звітах за даними за момент часу залишається незмінним. Наразі існуючі налаштування функцій мають пріоритет над параметром «Включити» під час визначення порядку стовпців. Наприклад, якщо для клієнта ввімкнено певний параметр функції, то цей стовпець функції відображається відповідно до старого формату звіту, навіть якщо ви додасте їх до параметра «Включити». Ми скоро видалимо ці налаштування. Після їх видалення ви можете запитувати додаткові стовпці лише за допомогою параметра 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 виводить список звітів разом з унікальним ідентифікатором звіту та статусом (ЗАВЕРШЕНО, В ПРОЦЕСІ_).
|
Що далі
Зробіть запис ідентифікатора для будь-яких звітів, які ви хочете завантажити. Щоб завантажити звіт, перейдіть за посиланням Отримати звіт про оптові виставлення рахунків.
Видалення звіту про оптову торгівлю
Використайте цю процедуру, щоб видалити згенерований звіт про виставлення рахунків на основі ідентифікатора звіту. Ось кілька прикладів, коли ви можете захотіти видалити звіт:
-
Якщо ви хочете повторно створити існуючий звіт про узгодження рахунків, спочатку потрібно видалити існуючий звіт. Після видалення існуючого звіту можна створити новий звіт за цей період. Ви не можете видалити звіт, якщо його створення не вдалося або ще триває.
Для звіту на певний момент часу не потрібно видаляти існуючий звіт, оскільки система не створює ці звіти повторно. Кожен звіт завжди відображає дані станом на поточну позначку часу.
-
Якщо ви надішлете URL-адресу згенерованого звіту не тій особі, ви можете видалити звіт, щоб вона не мала до нього доступу.
| 1 |
З developer.webex.comперейдіть до Видалити API звіту про оптову торгівлю. |
| 2 |
Введіть ідентифікатор звіту та натисніть кнопку « Виконати». |
Поля звіту про виставлення рахунків
Звіти про виставлення рахунків містять такі поля:
|
Поле |
Опис |
Підтримуваний тип звіту |
Підтримувана категорія звітів |
Обов'язковий або необов'язковий атрибут |
|---|---|---|---|---|
|
ІМ'Я ПАРТНЕРА_ |
Ім'я партнера |
ПАРТНЕР, КЛІЄНТ, КОРИСТУВАЧ |
Узгодження, момент часу |
Обов’язкове |
|
ІДЕНТИФІКАТОР ПАРТНЕРА_ОРГАНІЗАЦІЇ_ |
Унікальний ідентифікатор партнера |
ПАРТНЕР, КЛІЄНТ, КОРИСТУВАЧ |
Узгодження, момент часу |
Обов’язкове |
|
ІДЕНТИФІКАТОР ПІДПИСКИ_ |
Унікальний ідентифікатор підписки |
ПАРТНЕР, КЛІЄНТ, КОРИСТУВАЧ |
Узгодження, момент часу |
Обов’язкове |
|
_ІДЕНТИФІКАТОР ГРУПИ КЛІЄНТІВ_ | Унікальний ідентифікатор групи, до якої належить клієнт. Якщо клієнта переміщують між групами протягом розрахункового періоду, використання розподіляється на основі груп, до яких належав клієнт протягом цього періоду. |
КЛІЄНТ, КОРИСТУВАЧ |
Узгодження, момент часу |
Додатково |
|
НАЗВА ГРУПИ КЛІЄНТІВ__ | Відображувана назва групи клієнтів. Якщо назва групи змінилася протягом розрахункового періоду, використовується остання назва. |
КЛІЄНТ, КОРИСТУВАЧ |
Узгодження, момент часу |
Додатково |
|
ІДЕНТИФІКАТОР ОРГАНІЗАЦІЇ_КЛІЄНТА_ |
Внутрішній унікальний ідентифікатор клієнта |
КЛІЄНТ, КОРИСТУВАЧ |
Узгодження, момент часу |
Обов’язкове |
|
ЗОВНІШНІЙ ІДЕНТИФІКАТОР КЛІЄНТА__ |
Унікальний ідентифікатор клієнта, наданий партнером |
КЛІЄНТ, КОРИСТУВАЧ |
Узгодження, момент часу |
Обов’язкове |
|
ТИП |
Тип користувача або робочої області |
КЛІЄНТ, КОРИСТУВАЧ |
Момент часу |
Обов’язкове |
|
ІДЕНТИФІКАТОР ПІДПИСНИКА_ |
Унікальний ідентифікатор абонента |
КОРИСТУВАЧ |
Узгодження, момент часу |
Обов’язкове |
|
ІДЕНТИФІКАТОР КОРИСТУВАЧА_ |
Ідентифікатор користувача Webex передплатника |
КОРИСТУВАЧ |
Узгодження, момент часу |
Обов’язкове |
|
ІДЕНТИФІКАТОР РОБОЧОГО ПРОСТОРУ_ |
Унікальний ідентифікатор робочої області |
КОРИСТУВАЧ |
Узгодження, момент часу |
Обов’язкове |
|
НАЗВА ПОСЛУГИ_ |
Назва послуги (наприклад, ЗАГАЛЬНА_ЗОНА_ДЗВІНОК, WEBEX_ДЗВІНОК, WEBEX_ЛЮКС, WEBEX_ЗУСТРІЧІ) |
ПАРТНЕР, КЛІЄНТ, КОРИСТУВАЧ |
Узгодження, момент часу |
Обов’язкове |
|
SKU |
SKU для послуги |
ПАРТНЕР, КЛІЄНТ, КОРИСТУВАЧ |
Узгодження, момент часу |
Обов’язкове |
|
ОПИС |
Опис послуги |
ПАРТНЕР, КЛІЄНТ, КОРИСТУВАЧ |
Узгодження, момент часу |
Обов’язкове |
|
СПОЖИВАННЯ_ПОЧАТОК_ДАТА |
Початок споживання послуги. Разом із наступним полем це значення визначає період використання. |
ПАРТНЕР, КЛІЄНТ, КОРИСТУВАЧ |
Примирення |
Обов’язкове |
|
СПОЖИВАННЯ_КІНЕЦЬ_ДАТА |
Кінець споживання послуги. Разом із попереднім полем, це значення визначає період споживання. |
ПАРТНЕР, КЛІЄНТ, КОРИСТУВАЧ |
Примирення |
Обов’язкове |
|
ЗВІТ_ДАТА |
Дата та час створення звіту. |
КЛІЄНТ, КОРИСТУВАЧ |
Момент часу |
Обов’язкове |
|
КІЛЬКІСТЬ |
Представляє сукупне споживання користувачами на одного партнера, на одного клієнта або на одного користувача (залежно від звіту та рівня, на якому ви переглядаєте дані). Розрахунок: Система розраховує денну кількість для кожного користувача пропорційно за цей день. Використання протягом цілого дня = 1 Використання протягом півдня = 0,5 Потім він підсумовує загальні показники за день за всі дні розрахункового періоду, щоб обчислити загальну кількість для цього користувача протягом цього розрахункового періоду. Для звітів на рівні клієнтів та партнерів загальні суми для всіх користувачів агрегуються, щоб отримати загальну кількість для цього клієнта або партнера. Момент часу: У звіті клієнта перелічено розподіл пакетів для кожного клієнта. Кожен рядок відображає загальну кількість певного пакета, призначеного користувачам або робочим просторам у певній організації клієнта. Кількість показує «0», якщо немає розподілених пакетів. У звіті користувача перелічено пакети, призначені користувачам або робочим просторам. У кожному рядку показано кількість 1, що представляє користувача або робочу область та його індивідуальний пакет або доповнення. Якщо користувачеві або робочій області виділено кілька пакетів або доповнень, то у звіті відображається кілька записів, кожен з кількістю 1. |
ПАРТНЕР, КЛІЄНТ, КОРИСТУВАЧ |
Узгодження, момент часу |
Обов’язкове |
|
Ідентифікатор місцезнаходження_ |
Унікальний ідентифікатор місцезнаходження |
КЛІЄНТ, КОРИСТУВАЧ |
Узгодження, момент часу Звіт клієнта за даними моменту часу не містить ідентифікатора місцезнаходження |
Додатково |
|
ЛІЦЕНЗІЯ_ІДЕНТИФІКАТОР |
Ідентифікатор ліцензії Це поле видиме лише для оптових упаковок Для звіту про звірку ідентифікатор License_залишається порожнім для ліцензій, призначених до появи цього поля. У звіті про виставлення рахунків відображається кілька рядків для одного й того самого оптового пакету, якщо він пов’язаний з різними комбінаціями ідентифікатора МІСЦЕЗНАХОДЖЕННЯ_та ідентифікатора ЛІЦЕНЗІЇ_. |
КЛІЄНТ, КОРИСТУВАЧ |
Узгодження, момент часу |
Додатково |
Вибір необов’язкових стовпців змінює порядок стовпців у звітах про звірку клієнтів і користувачів. Наступний порядок застосовується до партнерів, які мають у своїй передплаті лише оптові артикули:
Звіт на рівні користувача — НАЗВА ПАРТНЕРА_, ІДЕНТИФІКАТОР ОРГАНІЗАЦІЇ_, ІДЕНТИФІКАТОР ПІДПИСКИ_[], ІДЕНТИФІКАТОР ГРУПИ _,_НАЗВА ГРУПИ_, ІДЕНТИФІКАТОР ОРГАНІЗАЦІЇ__, ІДЕНТИФІКАТОР КЛІЄНТА [] ЗОВНІШНІЙ__ІДЕНТИФІКАТОР , ІДЕНТИФІКАТОР МІСЦЕЗНАХОДЖЕННЯ__, ІДЕНТИФІКАТОР ЛІЦЕНЗІЇ__, ІДЕНТИФІКАТОР АБОНЕНТА_[], ІДЕНТИФІКАТОР КОРИСТУВАЧА _, ІДЕНТИФІКАТОР РОБОЧОГО ПРОСТОРУ__, НАЗВА ПОСЛУГИ_, АРТ. НОМЕР, ОПИС, ДАТА ПОЧАТКУ_, ДАТА КІНЦЯ__, КІЛЬКІСТЬ
Звіт на рівні клієнта — НАЗВА ПАРТНЕРА_, ІДЕНТИФІКАТОР ОРГАНІЗАЦІЇ__, ІДЕНТИФІКАТОР ПІДПИСКИ_, ІДЕНТИФІКАТОР ГРУПИ КЛІЄНТА_, ІДЕНТИФІКАТОР ГРУПИ КЛІЄНТА__, ІДЕНТИФІКАТОР ОРГАНІЗАЦІЇ_, ІДЕНТИФІКАТОР КЛІЄНТА__ЗОВНІШНІЙ ІДЕНТИФІКАТОР, ІДЕНТИФІКАТОР МІСЦЕЗНАХОДЖЕННЯ__, ІДЕНТИФІКАТОР ЛІЦЕНЗІЇ__, НАЗВА ПОСЛУГИ_, АРТ. НОМЕР, ОПИС, СПОЖИВАННЯ_ДАТА ПОЧАТКУ_, СПОЖИВАННЯ_ДАТА КІНЦЯ_, КІЛЬКІСТЬ
Надання пакета користувачеві запускає оптове виставлення рахунків Webex, а видалення призначення пакета зупиняє його.
Організація-клієнт може належати лише до однієї групи клієнтів одночасно. Підтримка кількох груп клієнтів на одну організацію наразі недоступна.
