إجراء تسويات في الفوترة

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X. معلومات

مقدمة

تتيح لك ميزة تحقيق الربح إجراء تعديلات على تفاصيل الفوترة. على سبيل المثال، قد تحتاج زيادة أو خفض حصة الأرباح أو الرسوم عن شهر فوترة معيّن بسبب تباينًا في سجلاتك.

استكشاف صفحة تسويات الفوترة

انتقل إلى صفحة تسويات الفوترة، كما هو موضح أدناه.

إضافة تسوية فوترة

لإضافة تسوية فوترة:

1. الوصول إلى صفحة تسويات الفوترة.
2. انقر على + تسوية.
3. أدخل المعلومات التالية:

   الحقل	الوصف
   الاسم	اسم وصفي سيظهر في مستند الفوترة.
   النسبة المئوية للتسوية	مبلغ التسوية، كنسبة موجبة أو سالبة. موجب تقوم النسبة المئوية بتعديل حصة الأرباح أو الرسوم في المعاملة بذلك النسبة المئوية. تؤدي التسوية السالبة إلى تسوية حصة الأرباح أو الرسوم في معاملة حسب تلك النسبة المئوية. يُرجى إدخال رقم عشري موجب أو سالب (مع رقم إلى منزلتين عشريتين).
   شهر الفوترة	شهر الفوترة للتسوية اختَر شهرًا من القائمة المنسدلة.
   نوع المعاملة	نوع المعاملة التي تريد تطبيق التسوية عليها اختَر القيمة من القائمة المنسدلة: كل المعاملات تحصيل الرسوم (نموذج شحن المعاملات) الشراء (معاملات نموذج مشاركة الأرباح) ردّ الأموال (معاملات نموذج مشاركة الأرباح)
   المنتج	منتج واجهة برمجة التطبيقات الذي تريد تطبيق التعديل عليه. لا يمكنك تطبيق تعديل واحد لعدة منتجات واجهة برمجة تطبيقات. إذا كنت بحاجة إلى تطبيق تسوية على منتجات متعددة لواجهة برمجة التطبيقات، يمكنك إنشاء تعديل لكل منتج. اختيار منتج لواجهة برمجة التطبيقات من القائمة المنسدلة.
   مطور التطبيق	المطوّر الذي تريد تطبيق التسوية عليه يمكنك تطبيق تعديلات لجميع المطوِّرين (بشكل تلقائي) أو لمطوّر برامج معيّن. اختيار "الكل المطوِّرون" أو مطور معين من القائمة المنسدلة.

4. انقر على إنشاء تعديل.

تعديل تسوية فوترة

لتعديل تسوية فوترة:

1. الوصول إلى صفحة تسويات الفوترة.
2. ضع مؤشر الماوس فوق تسوية الفوترة التي تريد تعديلها وانقر على في قائمة الإجراءات.
3. حدِّث تسوية الفوترة، كما هو مطلوب.
4. انقر على تعديل التسوية.

إجراء تسويات رصيد باستخدام واجهة برمجة التطبيقات

توضّح الأقسام التالية كيفية إجراء تسويات رصيد باستخدام واجهة برمجة التطبيقات.

إجراء تسوية فوترة باستخدام واجهة برمجة التطبيقات

يمكنك تعديل تفاصيل الفوترة عن طريق إصدار طلب POST إلى /organizations/{org_name}/billing-adjustments. عند تقديم الطلب، فإنك تحدد في نص الطلب:

• اسم تسوية الفوترة.
• يشير ذلك المصطلح إلى نسبة تعديل مئوية، وهي قيمة مئوية موجبة أو سالبة. على التوالي زيادة أو خفض الفاتورة.
• شهر الفوترة.
• سنة الفوترة.
• المؤسسة التي يتم تطبيق تسوية الفوترة عليها.

يمكنك أيضًا تحديد سمات أخرى، مثل:

• نوع المعاملة التي تريد تطبيق التسوية عليها (مثل عملية شراء معاملة).
• المطوّر الذي تريد تطبيق التسوية عليه
• سواء كنت تريد تطبيق التسوية على المطوّرين الذين يستخدمون نظام الدفع المُسبق أو المطوّرِين الذين يستخدمون نظام الدفع الآجل أو كليهما.
• حزمة واجهة برمجة التطبيقات التي تريد تطبيق التعديل عليها.
• منتج واجهة برمجة التطبيقات الذي تريد تطبيق التعديل عليه.

راجع إعدادات ضبط تسوية الفوترة للحصول على قائمة كاملة خصائص تسوية الفوترة التي يمكنك تحديدها في طلب تسوية.

في حال عدم تحديد خاصية اختيارية، ستخضع تسوية مستند الفوترة بالكامل شاملة لذلك الموقع. على سبيل المثال، إذا لم يتم تحديد نوع معاملة، فلن يتم تحديد سينطبق التعديل على جميع أنواع المعاملات.

يقوم المثال التالي بإجراء تسوية فوترة لشهر الفوترة المفتوح، حزيران (يونيو) 2013. تشير رسالة الأشكال البيانية تسويتها بعامل يبلغ 3%، ويتم تطبيقها على معاملات الشراء، ومنتج الدفع والمطورين بنظام الدفع عند الاستخدام. نظرًا لأن الخصائص المخصصة لتحديد موقع مطوّر البرامج أو حزمة واجهة برمجة التطبيقات، فسيتم تطبيق التعديل على جميع المطوّرين (الذين مطورو برامج الدفع عند الاستخدام)، ومنتج الدفع في جميع حزم واجهة برمجة التطبيقات.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "name": "Purchase Adjustment Negative3",
  "adjustmentPercentageFactor": -3,
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
  },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \
-u email:password

يجب أن يبدو الرد على النحو التالي (يظهر جزء فقط من الرد):

{
  "adjustmentPercentageFactor" : -3,
  "billingMonth" : 6,
  "billingYear" : 2017,
  "developerBillingType" : "POSTPAID",
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
  "isPublished" : false,
  "name" : "Purchase Adjustment Negative3",
  "organization" : {
   ...
  },
  "product" : {
    "customAtt1Name" : "user",
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "payment",
    "organization" : {
      ...
    },
    "status" : "CREATED",
    "transactionSuccessCriteria" : "Status=='200 OK'"
  },
  "transactionType" : "PURCHASE"
}

عرض تسويات رصيد الحساب باستخدام واجهة برمجة التطبيقات

يمكنك عرض تسوية فوترة محددة أو جميع تسويات رصيد الحساب لإحدى المؤسسات. للاطّلاع على تسوية فوترة معيّنة، يمكنك إصدار طلب استرداد بيانات باستخدام GET إلى /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}، حيث {billing_adjustment_id} هو تحديد تسوية فوترة محدّدة (يتم عرض المعرّف في الرد عند إنشاء تسوية الفوترة). على سبيل المثال:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

لعرض جميع تسويات رصيد الحساب لإحدى المؤسسات، يمكنك إصدار طلب استرداد بيانات باستخدام GET إلى /organizations/{org_name}/billing-adjustments على سبيل المثال:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \ 
-u email:password

يجب أن يبدو الرد على النحو التالي (يظهر جزء فقط من الرد):

{
  "billingAdjustment" : [ {
    "adjustmentPercentageFactor" : -3,
    "billingMonth" : 6,
    "billingYear" : 2017,
    "developerBillingType" : "POSTPAID",
    "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
    "isPublished" : false,
    "name" : "Purchase Adjustment Negative3",
    "organization" : {
      ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    },
    "transactionType" : "PURCHASE"
  }, {
    "adjustmentPercentageFactor" : 5.0000,
    "billingMonth" : 5,
    "billingYear" : 2017,
    "id" : "53c363c0-7e1d-4dc1-9392-cf86656225f2",
    "isPublished" : false,
    "monetizationPackage" : {
      "description" : "Communications",
      "displayName" : "Communications",
      "id" : "communications",
      "name" : "Communications",
      "organization" : {
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Messaging",
        "displayName" : "Messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
          ...
        },
        "status" : "CREATED"
      }, {
        ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Test Package Adjustment",
    "organization" : {
     ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    }
  } ],
  "totalRecords" : 2
}

تعديل تسوية فوترة باستخدام واجهة برمجة التطبيقات

يمكنك تحديث تسوية فوترة عن طريق إصدار طلب PUT إلى /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}، حيث {billing_adjustment_id} هو تعريف تسوية الفوترة المحدّدة. عند إجراء التحديث، عليك تحديد الخصائص المعدّلة في نص الطلب تعريف تسوية الفوترة التي سيتم تحديثها. يجب عليك أيضًا تحديد خيارات خصائص تسوية الفوترة، أي خصائص الاسم والنسبة المئوية للتسوية شهر الفوترة وسنة الفوترة والمؤسسة.

على سبيل المثال، يعمل طلب البيانات من واجهة برمجة التطبيقات التالي على تعديل عامل النسبة المئوية للتعديل والاسم ( تم تسليط الضوء على الخصائص المعدّلة في المثال):

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c ",
  "adjustmentPercentageFactor": -5,
  "name" : "Purchase Adjustment Negative5",
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
    },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

حذف تسوية فوترة باستخدام واجهة برمجة التطبيقات

يمكنك حذف تسوية فوترة عن طريق إصدار طلب حذف /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}، حيث {billing_adjustment_id} هو تحديد تسوية الفوترة التي يجب حذف. على سبيل المثال:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

إعدادات ضبط تسوية الفوترة لواجهة برمجة التطبيقات

تتوفر خيارات الضبط التالية لتسويات رصيد الحساب:

الخطوات التالية

تمنحك ميزة تحقيق الربح المرونة في إصدار أرصدة إلى المطوِّر. قد تحتاج إلى إجراء هذا إذا كان المطوّر غير راضٍ عن الخدمة وقدَّم طلب استرداد جزء من الأموال أو الأموال بالكامل مقابل الاستخدام لفترة معينة. تعرَّف على كيفية إصدار الرصيد في قسم إصدار الأرصدة.