تقارير الفواتير
يمكن للشركاء استخدام واجهات برمجة تطبيقات فواتير البيع بالجملة التالية لإنشاء تقارير الفواتير التي تساعدهم على التحقق من دقة الاستخدام والتزويد. يمكن الوصول إلى واجهات برمجة تطبيقات الفواتير بالجملة من خلال developer.webex.com.
-
التسوية - تعرض استهلاك الاستخدام على مستوى كل شريك أو عميل أو لكل مستخدم. يمكن للشركاء استخدام معلومات تقرير الفواتير المخصصة هذه لتسوية فاتورتهم الشهرية حتى يتمكنوا من إصدار فواتير لعملائهم ومستخدميهم وفقًا لاستهلاك الاستخدام.
-
Point-In-Time—يعرض تخصيصات الحزمة الحالية على مستوى كل عميل أو لكل مستخدم. يوفر تقرير Point-In-Time حسابًا في الوقت الفعلي لتخصيصات الحزم. يمكن للشركاء استخدام هذه المعلومات للتحقق من دقة التزويد وضمان التوافق مع طلبات العملاء.
يمكن للشركاء أيضًا إنشاء تقارير فواتير مخصصة للشركاء الفرعيين باستخدام المعلمة subpartnerOrGid.
هناك أربع واجهات برمجة تطبيقات متاحة لمسؤولي الشركاء الذين يستوفون الحد الأدنى من متطلبات الوصول.
|
واجهة برمجة تطبيقات الفواتير |
الغرض من API |
متطلبات الوصول لمسؤول الشريك |
|---|---|---|
|
إنشاء تقرير فواتير البيع بالجملة |
يُستخدم لإنشاء تقرير الفواتير. |
القراءة/الكتابة |
|
احصل على تقرير فواتير البيع بالجملة |
يُستخدم للحصول على تقرير الفواتير الذي تم إنشاؤه للتنزيل. |
اقرأ |
|
قائمة تقارير فواتير البيع بالجملة |
يُستخدم لسرد تقارير الفواتير الموجودة لهذا الشريك. |
اقرأ |
|
حذف تقرير فواتير البيع بالجملة |
يُستخدم لحذف تقرير الفواتير الحالي. |
القراءة/الكتابة |
مصدر البيانات
يتم سحب بيانات تقارير الفواتير من تعيينات الحزمة وبيانات الاستخدام التي تتعقبها Webex لكل شريك. تقوم Webex بتجميع بيانات حزمة العميل والمستخدم يوميًا لإنشاء الفاتورة الشهرية للشريك. تستخدم واجهات برمجة تطبيقات إعداد الفواتير هذه البيانات، مما يسمح لمسؤولي الشركاء بإنشاء تقارير مخصصة. تساعد هذه التقارير الشركاء على التوفيق بين استهلاك الاستخدام من فاتورتهم الشهرية على مستويات الشريك والعميل والمستخدم.
لمزيد من المعلومات التفصيلية حول كيفية إصدار Webex لفواتير الشركاء، راجع فواتير موفر الخدمة.
إنشاء تقرير فواتير البيع بالجملة
| 1 |
من developer.webex.com، انتقل إلى إنشاء واجهة برمجة تطبيقات تقرير الفواتير بالجملة. |
| 2 |
حدد أيًا من فئات التقارير التالية:
إذا كنت ترغب في إنشاء تقرير التسوية، فلا داعي لتغيير أي شيء لأن التسوية محددة افتراضيًا، لذا يمكنك المتابعة إلى الخطوة التالية. إذا كنت ترغب في إنشاء تقرير Point-In-Time، قم بتغيير التحديد إلى Point-In-Time. |
| 3 |
أدخل BillingStartDate و BillingEndDate بالتنسيق الذي تحدده واجهة برمجة التطبيقات. يمكنك إدخال أي تاريخ من السنوات الخمس الماضية، ولكن ليس اليوم الحالي. بالنسبة لتقرير Point-In-Time، لا يلزم وجود حقلي BillingStartDate وBillingEndDate ويتم تجاهلهما إذا تم إدخالهما. يعكس التقرير دائمًا تخصيصات الحزمة الحالية. |
| 4 |
أدخل نوع التقرير:
|
| 5 |
في حقل التضمين، أدخل الأعمدة الإضافية أو الاختيارية التي تريد رؤيتها في التقارير. يحتوي كل نوع تقرير على مجموعة من السمات الإلزامية ومجموعة من السمات الاختيارية. يمكنك تحديد السمات الاختيارية التي سيتم عرضها لكل تقرير. إذا لم تقم بتضمين السمات الاختيارية، فسيعرض التقرير السمات الإلزامية فقط. الأعمدة التالية هي السمات الاختيارية التي يمكنك طلب تضمينها في تقرير العميل والمستخدم:
يجب عليك تضمينها CUSTOMER_GROUP_ID CUSTOMER_GROUP_NAME معًا إذا كنت تريد رؤية هذه السمات في تقريرك. عند تحديد أعمدة اختيارية، يتغير ترتيب الأعمدة في تقارير تسوية العملاء والمستخدمين. يجب على الشركاء تحديث تكامل API الخاص بهم لقبول تنسيق csv الجديد. يظل ترتيب الأعمدة لتقارير Point-In-Time بدون تغيير. حاليًا، تتمتع إعدادات الميزات الحالية بالأسبقية على المعلمة Include عند تحديد ترتيب الأعمدة. على سبيل المثال، إذا تم تمكين إعداد ميزة معين لأحد العملاء، فسيظهر عمود المعالم هذا وفقًا لتنسيق التقرير القديم حتى إذا قمت بإضافته في المعلمة Include. سنزيل هذه الإعدادات قريبًا. بمجرد إزالتها، يمكنك طلب الأعمدة الاختيارية فقط من خلال المعلمة Include. |
| 6 |
انقر فوق تشغيل لإنشاء التقرير. |
| 7 |
انسخ معرف التقرير من إخراج API. يمكنك استخدام هذه القيمة مع Get API للحصول على تقرير الفواتير الذي تم إنشاؤه. |
ما يجب القيام به بعد ذلك
انتقل إلى قسم الحصول على تقرير فواتير البيع بالجملة لتنزيل نسخة من التقرير.
احصل على تقرير فواتير البيع بالجملة
بمجرد إنشاء تقرير الفواتير، استخدم واجهة برمجة التطبيقات هذه للحصول على تقرير فواتير محدد. يتم إخراج التقرير إلى عنوان URL حيث يكون متاحًا للتنزيل لمدة 30 دقيقة بعد إكمال طلب GET.
| 1 |
من developer.webex.com، انتقل إلى الحصول على واجهة برمجة تطبيقات تقرير الفواتير بالجملة. |
| 2 |
أدخل قيمة المعرف الفريد للتقرير وانقر فوق تشغيل. حالة تقرير مخرجات API. يتضمن الإخراج المعلمة TempDownloadURL، التي توفر عنوان URL يمكنك من خلاله تنزيل التقرير. |
| 3 |
انسخ TempDownloadURL إلى متصفح للوصول إلى التقرير وتنزيله. |
قائمة تقارير فواتير البيع بالجملة
استخدم واجهة برمجة التطبيقات هذه للحصول على قائمة بتقارير الفواتير التي تم إنشاؤها للمؤسسة الشريكة. يمكنك إدراج جميع التقارير الحالية، أو قصر القائمة على تلك التقارير التي تلبي المعلمات المحددة مثل فترة الفاتورة ونوع الفاتورة (الشريك، العميل، المستخدم).
في حالة إدخال المعلمات الاختيارية، تقوم واجهة برمجة التطبيقات بإرجاع التقارير التي تتطابق تمامًا مع المعلمات التي تحددها. على سبيل المثال، إذا قمت بتحديد فترة إعداد الفواتير، فلن يتم إرجاع سوى التقارير التي تستخدم فترة إعداد الفواتير المحددة هذه. لا يتم إرجاع التقارير التي تقع ضمن الفترة، ولكنها لا تتطابق تمامًا مع التواريخ.
| 1 |
من developer.webex.com، انتقل إلى قائمة واجهة برمجة تطبيقات تقرير الفواتير بالجملة. |
| 2 |
ضمن معاملات الاستعلام، أدخل أية معاملات بحث تريد استخدامها (على سبيل المثال، تاريخ البدء وتاريخ الانتهاء والنوع والفرز حسب). |
| 3 |
انقر فوق تشغيل. تقوم واجهة برمجة التطبيقات بإخراج قائمة التقارير جنبًا إلى جنب مع معرف التقرير الفريد وحالته (مكتمل،IN_PROGRESS).
|
ما يجب القيام به بعد ذلك
قم بتسجيل الرقم التعريفي لأية تقارير تريد تنزيلها. انتقل إلى الحصول على تقرير فواتير البيع بالجملة لتنزيل التقرير.
حذف تقرير فواتير البيع بالجملة
استخدم هذا الإجراء لحذف تقرير الفواتير الذي تم إنشاؤه استنادًا إلى معرف التقرير. تتضمن بعض الأمثلة التي قد ترغب في حذف تقرير فيها ما يلي:
-
إذا كنت ترغب في إعادة إنشاء تقرير فواتير التسوية الحالي، يجب عليك أولاً حذف التقرير الحالي. بعد حذف التقرير الحالي، يمكنك إنشاء تقرير جديد لتلك الفترة. لا يمكنك حذف تقرير إذا فشل إنشائه أو لا يزال قيد التقدم.
بالنسبة لتقرير Point-In-Time، لا تحتاج إلى حذف تقرير موجود، لأن النظام لا يقوم بإعادة إنشاء هذه التقارير. يعكس كل تقرير دائمًا البيانات اعتبارًا من الطابع الزمني الحالي.
-
إذا قمت بإرسال عنوان URL للتقرير الذي تم إنشاؤه إلى الشخص الخطأ، يمكنك حذف التقرير حتى لا يتمكن من الوصول إليه.
| 1 |
من developer.webex.com، انتقل إلى حذف واجهة برمجة تطبيقات تقرير الفواتير بالجملة. |
| 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 بعد ذلك، تقوم بجمع إجماليات اليوم لجميع الأيام خلال فترة الفاتورة لحساب الكمية الإجمالية لهذا المستخدم خلال فترة الفاتورة تلك. بالنسبة للتقارير على مستوى العملاء والشركاء، يتم تجميع الإجماليات لجميع المستخدمين لتوفير الكمية الإجمالية لذلك العميل أو الشريك. Point-In-Time: يسرد تقرير العميل تخصيصات الحزم لكل عميل. يمثل كل صف الكمية الإجمالية لحزمة معينة تم تعيينها للمستخدمين أو مساحات العمل داخل مؤسسة عميل معينة. تظهر الكمية «0" إذا لم تكن هناك حزم مخصصة. يسرد تقرير المستخدم الحزم المعينة للمستخدمين أو مساحات العمل. يعرض كل صف كمية قدرها 1، تمثل المستخدم أو مساحة العمل والحزمة الفردية أو الإضافة الخاصة بهم. إذا تم تخصيص حزم أو إضافات متعددة لمستخدم أو مساحة عمل، فسيعرض التقرير إدخالات متعددة، كل منها بكمية 1. |
PARTNER, CUSTOMER, USER |
المصالحة، في الوقت المناسب |
إلزامي |
|
LOCATION_ID |
معرف الموقع الفريد |
CUSTOMER, USER |
المصالحة، في الوقت المناسب لا يتضمن تقرير العميل في الوقت المحدد معرف الموقع |
اختياري |
|
LICENSE_ID |
معرف الترخيص هذا الحقل مرئي فقط لحزم البيع بالجملة بالنسبة لتقرير التسوية، License_ID يكون الحقل فارغًا للتراخيص المعينة قبل إدخال هذا الحقل. يعرض تقرير الفواتير صفوفًا متعددة لنفس حزمة البيع بالجملة إذا كانت مرتبطة بمجموعات مختلفة من LOCATION_ID وLICENSE_ID. |
CUSTOMER, USER |
المصالحة، في الوقت المناسب |
اختياري |
يؤدي تحديد الأعمدة الاختيارية إلى تعديل ترتيب الأعمدة لتقارير تسوية العملاء والمستخدمين. ينطبق الترتيب التالي على الشركاء الذين لديهم وحدات SKU بالجملة فقط في اشتراكهم:
تقرير مستوى المستخدم—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_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_IDSERVICE_NAME, SKU, الوصف,CONSUMPTION_START_DATE,CONSUMPTION_END_DATE, الكمية
يؤدي توفير حزمة إلى مستخدم إلى تشغيل فواتير Webex Wholesale، بينما تؤدي إزالة تعيين الحزمة إلى إيقافها.
يمكن أن تنتمي مؤسسة العملاء إلى مجموعة عملاء واحدة فقط في أي وقت. الدعم لمجموعات العملاء المتعددة لكل مؤسسة غير متاح حاليًا.