تقارير الفواتير
يمكن للشركاء استخدام واجهات برمجة تطبيقات الفوترة بالجملة التالية لإنشاء تقارير الفوترة التي تساعدهم على التحقق من دقة الاستخدام والتزويد. يمكن الوصول إلى واجهات برمجة تطبيقات الفوترة بالجملة من خلال developer.webex.com.
-
المطابقة - تعرض استهلاك الاستخدام على مستوى كل شريك أو كل عميل أو كل مستخدم. يمكن للشركاء استخدام معلومات تقرير الفوترة المخصص هذا لتسوية فواتيرهم الشهرية حتى يتمكنوا من إصدار فواتير لعملائهم ومستخدميهم وفقًا لاستهلاكهم.
-
عرض في وقت محدد - يعرض تخصيصات الحزم الحالية على مستوى كل عميل أو كل مستخدم. يقدم تقرير "نقطة في الوقت" إحصاءً فورياً لتخصيصات الحزم. يمكن للشركاء استخدام هذه المعلومات للتحقق من دقة التزويد وضمان التوافق مع طلبات العملاء.
يمكن للشركاء أيضًا إنشاء تقارير فوترة مخصصة للشركاء الفرعيين باستخدام معلمة subPartnerOrgId.
هناك أربع واجهات برمجة تطبيقات متاحة لمسؤولي الشركاء الذين يستوفون الحد الأدنى من متطلبات الوصول.
|
واجهة برمجة تطبيقات الفوترة |
الغرض من واجهة برمجة التطبيقات (API) |
متطلبات الوصول الإداري للشريك |
|---|---|---|
|
إنشاء تقرير فواتير الجملة |
يستخدم لإنشاء تقرير الفوترة. |
Read/write |
|
احصل على تقرير فواتير الجملة |
يُستخدم للحصول على تقرير فواتير مُنشأ لتنزيله. |
اقرأ |
|
تقارير فواتير البيع بالجملة |
تُستخدم لعرض قائمة بتقارير الفواتير الموجودة لهذا الشريك. |
اقرأ |
|
حذف تقرير فواتير الجملة |
تُستخدم لحذف تقرير فوترة موجود. |
Read/write |
مصدر البيانات
يتم استخلاص البيانات الخاصة بتقارير الفوترة من تخصيصات الحزم وبيانات الاستخدام التي يتتبعها Webex لكل شريك. يقوم Webex بتجميع بيانات حزمة العميل والمستخدم يوميًا لإنشاء الفاتورة الشهرية للشريك. تستخدم واجهات برمجة تطبيقات الفوترة هذه البيانات، مما يسمح لمسؤولي الشركاء بإنشاء تقارير مخصصة. تساعد هذه التقارير الشركاء على مطابقة استهلاك الاستخدام من فاتورتهم الشهرية على مستوى الشريك والعميل والمستخدم.
للحصول على معلومات أكثر تفصيلاً حول كيفية قيام Webex بإصدار الفواتير للشركاء، انظر فوترة مزود الخدمة.
إنشاء تقرير فواتير البيع بالجملة
| 1 |
من developer.webex.com، انتقل إلى إنشاء واجهة برمجة تطبيقات تقرير فواتير الجملة. |
| 2 |
اختر أيًا من فئات التقارير التالية:
إذا كنت ترغب في إنشاء تقرير تسوية، فلا داعي لتغيير أي شيء لأن التسوية محددة افتراضيًا، لذا يمكنك المتابعة إلى الخطوة التالية. إذا كنت ترغب في إنشاء تقرير نقطة زمنية، فقم بتغيير التحديد إلى نقطة زمنية. |
| 3 |
أدخل billingStartDate و billingEndDate بالتنسيق الذي تحدده واجهة برمجة التطبيقات (API). يمكنك إدخال أي تاريخ من السنوات الخمس الماضية، ولكن ليس اليوم الحالي. بالنسبة لتقرير نقطة في الوقت، فإن حقلي billingStartDate و billingEndDate ليسا مطلوبين ويتم تجاهلهما إذا تم إدخالهما. يعكس التقرير دائماً توزيعات الحزم الحالية. |
| 4 |
أدخل نوع التقرير :
|
| 5 |
في حقل تضمين ، أدخل الأعمدة الإضافية أو الاختيارية التي تريد رؤيتها في التقارير. يحتوي كل نوع من أنواع التقارير على مجموعة من السمات الإلزامية ومجموعة من السمات الاختيارية. يمكنك تحديد أي من السمات الاختيارية التي تريد عرضها لكل تقرير. إذا لم تقم بتضمين السمات الاختيارية، فسيعرض التقرير السمات الإلزامية فقط. الأعمدة التالية هي السمات الاختيارية التي يمكنك طلب تضمينها في تقرير العملاء والمستخدمين:
يجب عليك تضمين CUSTOMER_GROUP_ID و CUSTOMER_GROUP_NAME معًا إذا كنت تريد رؤية هذه السمات في تقريرك. عند تحديد الأعمدة الاختيارية، يتغير ترتيب الأعمدة في تقارير مطابقة العملاء والمستخدمين. يجب على الشركاء تحديث تكامل واجهة برمجة التطبيقات الخاصة بهم لقبول تنسيق CSV الجديد. يبقى ترتيب الأعمدة في تقارير نقطة زمنية محددة دون تغيير. حالياً، تُعطى الأولوية لإعدادات الميزات الحالية على معلمة التضمين عند تحديد ترتيب الأعمدة. على سبيل المثال، إذا تم تمكين إعداد ميزة معينة لأحد العملاء، فسيظهر عمود الميزة هذا وفقًا لتنسيق التقرير القديم حتى إذا قمت بإضافته في معلمة التضمين. سنقوم بإزالة هذه الإعدادات قريباً. بمجرد إزالتها، يمكنك طلب الأعمدة الاختيارية فقط من خلال معلمة التضمين. |
| 6 |
انقر فوق تشغيل لإنشاء التقرير. |
| 7 |
انسخ معرف التقرير من مخرجات واجهة برمجة التطبيقات (API). يمكنك استخدام هذه القيمة مع واجهة برمجة التطبيقات Get للحصول على تقرير الفواتير الذي تم إنشاؤه. |
التصرف التالي
انتقل إلى قسم الحصول على تقرير فواتير الجملة لتنزيل نسخة من التقرير.
احصل على تقرير فواتير الجملة
بمجرد إنشاء تقرير الفواتير، استخدم واجهة برمجة التطبيقات هذه للحصول على تقرير فواتير محدد. يتم إخراج التقرير إلى عنوان URL حيث يكون متاحًا للتنزيل لمدة 30 دقيقة بعد اكتمال طلب GET.
| 1 |
من developer.webex.com، انتقل إلى الحصول على واجهة برمجة تطبيقات تقرير فواتير الجملة. |
| 2 |
أدخل قيمة المعرف الفريد للتقرير وانقر على تشغيل. تُخرج واجهة برمجة التطبيقات تقرير الحالة. يتضمن الناتج المعلمة tempDownloadURL ، والتي توفر عنوان URL يمكنك من خلاله تنزيل التقرير. |
| 3 |
انسخ tempDownloadURL إلى متصفح للوصول إلى التقرير وتنزيله. |
قائمة تقارير فواتير البيع بالجملة
استخدم واجهة برمجة التطبيقات هذه للحصول على قائمة بتقارير الفواتير التي تم إنشاؤها للمنظمة الشريكة. يمكنك سرد جميع التقارير الموجودة، أو حصر القائمة في تلك التقارير التي تفي بالمعايير المحددة مثل فترة الفوترة ونوع الفوترة (شريك، عميل، مستخدم).
إذا قمت بإدخال معلمات اختيارية، فإن واجهة برمجة التطبيقات (API) لا تُرجع إلا تلك التقارير التي تتطابق تمامًا مع المعلمات التي تحددها. على سبيل المثال، إذا قمت بتحديد فترة فوترة، فسيتم إرجاع التقارير التي تستخدم فترة الفوترة المحددة فقط. التقارير التي تقع ضمن الفترة المحددة، ولكنها لا تتطابق تمامًا مع التواريخ، لا يتم إرجاعها.
| 1 |
من developer.webex.com، انتقل إلى List Wholesale Billing Report API. |
| 2 |
تحت معلمات الاستعلام، أدخل أي معلمات بحث تريد استخدامها (على سبيل المثال، تاريخ البدء، تاريخ الانتهاء، النوع، الفرز حسب). |
| 3 |
انقر تشغيل. تقوم واجهة برمجة التطبيقات بإخراج قائمة التقارير بالإضافة إلى معرف التقرير الفريد وحالته (مكتمل،_قيد التقدم).
|
التصرف التالي
احتفظ بسجل لـ id لأي تقارير ترغب في تنزيلها. انتقل إلى احصل على تقرير فواتير الجملة لتنزيل التقرير.
حذف تقرير فواتير الجملة
استخدم هذا الإجراء لحذف تقرير الفوترة الذي تم إنشاؤه بناءً على معرف التقرير. تتضمن بعض الأمثلة التي قد ترغب فيها بحذف تقرير ما ما يلي:
-
إذا كنت ترغب في إعادة إنشاء تقرير فواتير التسوية الحالي، فيجب عليك أولاً حذف التقرير الحالي. بعد حذف التقرير الحالي، يمكنك إنشاء تقرير جديد لتلك الفترة. لا يمكنك حذف تقرير إذا فشلت عملية إنشائه أو كانت لا تزال قيد التقدم.
بالنسبة لتقرير نقطة زمنية محددة، لا تحتاج إلى حذف تقرير موجود، لأن النظام لا يعيد إنشاء هذه التقارير. يعكس كل تقرير البيانات دائمًا حتى تاريخه الزمني الحالي.
-
إذا أرسلت رابط تقرير تم إنشاؤه إلى الشخص الخطأ، يمكنك حذف التقرير حتى لا يتمكن من الوصول إليه.
| 1 |
من developer.webex.com، انتقل إلى حذف واجهة برمجة تطبيقات تقرير فواتير البيع بالجملة. |
| 2 |
أدخل معرف التقرير وانقر على تشغيل . |
حقول تقرير الفواتير
تحتوي تقارير الفواتير على الحقول التالية:
|
ميدان |
الوصف |
نوع التقرير المدعوم |
فئة التقرير المدعومة |
سمة إلزامية أو اختيارية |
|---|---|---|---|---|
|
اسم الشريك_ |
اسم الشريك |
الشريك، العميل، المستخدم |
المصالحة، نقطة زمنية محددة |
إلزامي |
|
الشريك_المنظمة_المعرف |
معرّف الشريك الفريد |
الشريك، العميل، المستخدم |
المصالحة، نقطة زمنية محددة |
إلزامي |
|
معرف الاشتراك_ |
معرّف اشتراك فريد |
الشريك، العميل، المستخدم |
المصالحة، نقطة زمنية محددة |
إلزامي |
|
معرف العميل_معرف المجموعة_ | المعرف الفريد للمجموعة التي ينتمي إليها العميل. إذا تم نقل العميل بين المجموعات خلال فترة الفوترة، يتم تقسيم الاستخدام بناءً على المجموعات التي كان العميل ينتمي إليها خلال تلك الفترة. |
العميل، المستخدم |
المصالحة، نقطة زمنية محددة |
اختياري |
|
اسم العميل_اسم المجموعة_ | اسم عرض مجموعة العملاء. إذا تغير اسم المجموعة خلال فترة الفوترة، فسيتم استخدام الاسم الأخير. |
العميل، المستخدم |
المصالحة، نقطة زمنية محددة |
اختياري |
|
معرف العميل_معرف المنظمة_ |
معرّف العميل الداخلي الفريد |
العميل، المستخدم |
المصالحة، نقطة زمنية محددة |
إلزامي |
|
معرف العميل_معرف خارجي_ |
معرّف العميل الفريد كما هو مقدم من أحد الشركاء |
العميل، المستخدم |
المصالحة، نقطة زمنية محددة |
إلزامي |
|
يكتب |
نوع المستخدم أو مساحة العمل |
العميل، المستخدم |
نقطة في الزمن |
إلزامي |
|
معرف المشترك_ |
معرّف فريد للمشترك |
مستخدم |
المصالحة، نقطة زمنية محددة |
إلزامي |
|
معرف المستخدم_ |
معرف مستخدم Webex الخاص بالمشترك |
مستخدم |
المصالحة، نقطة زمنية محددة |
إلزامي |
|
مساحة العمل_المعرف |
معرّف مساحة العمل الفريد |
مستخدم |
المصالحة، نقطة زمنية محددة |
إلزامي |
|
اسم الخدمة_ |
اسم الخدمة (مثال: COMMON_AREA_CALLING، WEBEX_CALLING، WEBEX_SUITE، WEBEX_MEETINGS) |
الشريك، العميل، المستخدم |
المصالحة، نقطة زمنية محددة |
إلزامي |
|
SKU |
رمز الخدمة |
الشريك، العميل، المستخدم |
المصالحة، نقطة زمنية محددة |
إلزامي |
|
وصف |
وصف الخدمة |
الشريك، العميل، المستخدم |
المصالحة، نقطة زمنية محددة |
إلزامي |
|
تاريخ بدء الاستهلاك__ |
بدء استهلاك الخدمة. إلى جانب الحقل التالي، تحدد هذه القيمة فترة الاستخدام. |
الشريك، العميل، المستخدم |
التسوية |
إلزامي |
|
تاريخ الاستهلاك_تاريخ الانتهاء_ |
نهاية استهلاك الخدمة. إلى جانب الحقل السابق، تحدد هذه القيمة فترة استهلاك الاستخدام. |
الشريك، العميل، المستخدم |
التسوية |
إلزامي |
|
تقرير_التاريخ |
تاريخ ووقت إنشاء التقرير. |
العميل، المستخدم |
نقطة في الزمن |
إلزامي |
|
كمية |
يمثل هذا إجمالي استهلاك استخدام المستخدم لكل شريك أو لكل عميل أو لكل مستخدم (اعتمادًا على التقرير والمستوى الذي تعرض فيه البيانات). حساب: يقوم النظام بحساب الكمية اليومية لكل مستخدم على أساس تناسبي لذلك اليوم. الاستخدام ليوم كامل = 1 الاستخدام لمدة نصف يوم = 0.5 ثم يقوم بجمع الإجماليات اليومية لجميع الأيام خلال فترة الفوترة لحساب الكمية الإجمالية لهذا المستخدم خلال فترة الفوترة تلك. بالنسبة للتقارير على مستوى العملاء والشركاء، يتم تجميع الإجماليات لجميع المستخدمين لتوفير إجمالي الكمية لذلك العميل أو الشريك. نقطة زمنية محددة: يتضمن تقرير العملاء قائمة بتوزيعات الباقات لكل عميل. يمثل كل صف الكمية الإجمالية لحزمة معينة مخصصة للمستخدمين أو مساحات العمل داخل مؤسسة عميل معينة. تظهر الكمية "0" إذا لم يتم تخصيص أي حزم. يسرد تقرير المستخدم الحزم المخصصة للمستخدمين أو مساحات العمل. يُظهر كل صف كمية 1، تمثل مستخدمًا أو مساحة عمل وحزمتهم أو إضافاتهم الفردية. إذا تم تخصيص حزم أو إضافات متعددة لمستخدم أو مساحة عمل، فسيعرض التقرير عدة إدخالات، كل منها بكمية 1. |
الشريك، العميل، المستخدم |
المصالحة، نقطة زمنية محددة |
إلزامي |
|
الموقع_المعرف |
معرّف الموقع الفريد |
العميل، المستخدم |
المصالحة، نقطة زمنية محددة لا يتضمن تقرير نقطة زمنية للعميل معرف الموقع |
اختياري |
|
رقم الترخيص_ |
معرّف الترخيص هذا الحقل مرئي فقط لحزم البيع بالجملة بالنسبة لتقرير المطابقة، يكون حقل License_ID فارغًا بالنسبة للتراخيص المخصصة قبل إدخال هذا الحقل. يُظهر تقرير الفواتير عدة صفوف لنفس حزمة البيع بالجملة إذا كانت مرتبطة بمجموعات مختلفة من معرف الموقع_ومعرف الترخيص_. |
العميل، المستخدم |
المصالحة، نقطة زمنية محددة |
اختياري |
يؤدي تحديد الأعمدة الاختيارية إلى تغيير ترتيب الأعمدة في تقارير مطابقة العملاء والمستخدمين. ينطبق الترتيب التالي على الشركاء الذين لديهم فقط وحدات تخزين بالجملة في اشتراكهم:
تقرير على مستوى المستخدم - اسم الشريك_، معرف مؤسسة_الشريك_، معرف الاشتراك_، معرف مجموعة العميل_، اسم مجموعة العميل_، معرف مؤسسة العميل_، معرف العميل الخارجي_، معرف_الموقع_، معرف_الترخيص_، معرف المشترك_، معرف_المستخدم_، معرف مساحة العمل_، اسم الخدمة_، رمز المنتج، الوصف_،_تاريخ بدء الاستهلاك_، تاريخ انتهاء_الاستهلاك_، الكمية
تقرير على مستوى العميل - اسم_الشريك ، معرف مؤسسة_الشريك_، معرف الاشتراك_، معرف مجموعة العميل_، اسم مجموعة العميل_،_معرف مؤسسة العميل_، معرف العميل_الخارجي_، معرف الموقع_، معرف الترخيص_، اسم الخدمة_، رمز المنتج_، الوصف_،_تاريخ بدء الاستهلاك_، تاريخ انتهاء_الاستهلاك_، الكمية
يؤدي توفير حزمة لمستخدم إلى تشغيل عملية فوترة Webex Wholesale، بينما يؤدي إزالة تخصيص الحزمة إلى إيقافها.
لا يمكن لمنظمة العملاء أن تنتمي إلا إلى مجموعة عملاء واحدة في أي وقت. لا يتوفر حاليًا دعم لمجموعات عملاء متعددة لكل مؤسسة.